stage

Documentation

Index

• type Fly
  • func New(client flies.RestClient, channelID, token string) *Fly
  • func (f *Fly) Delete(ctx context.Context, reason string) error
  • func (f *Fly) Get(ctx context.Context) (*sigil.StageInstance, error)
  • func (f *Fly) Modify(ctx context.Context, reason string, opts *ModifyOptions) error
• type ModifyOptions

Types

type Fly

type Fly struct {
	// contains filtered or unexported fields
}

Fly is a resource for interacting with Stage Instances.

func New

func New(client flies.RestClient, channelID, token string) *Fly

New creates a new Fly. `channelID` should be the ID of a Stage Channel.

func (*Fly) Delete

func (f *Fly) Delete(ctx context.Context, reason string) error

Delete removes the Stage Instance.

The current User must be a moderator of the associated Channel.

func (*Fly) Get

func (f *Fly) Get(ctx context.Context) (*sigil.StageInstance, error)

Get fetches the Stage Instance.

The current User must be a moderator of the associated Channel.

func (*Fly) Modify

func (f *Fly) Modify(ctx context.Context, reason string, opts *ModifyOptions) error

Modify modifies the Stage Instance.

The current User must be a moderator of the associated Channel.

type ModifyOptions

type ModifyOptions struct {
	Topic        string             `json:"topic,omitempty"`
	PrivacyLevel sigil.PrivacyLevel `json:"privacy_level,omitempty"`
}

ModifyOptions are used to modify a Stage.