invite

Documentation

Index

• type Resource
  • func NewResource(c resource.RestClient, code string) *Resource
  • func (r *Resource) Delete(ctx context.Context) (*discord.Invite, error)
  • func (r *Resource) DeleteWithReason(ctx context.Context, reason string) (*discord.Invite, error)
  • func (r *Resource) Get(ctx context.Context, withCounts bool) (*discord.Invite, error)

Types

type Resource

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

Resource is a resource that allows to perform various actions on a Discord guild invite. Create one with Client.Invite.

func NewResource

func NewResource(c resource.RestClient, code string) *Resource

func (*Resource) Delete

func (r *Resource) Delete(ctx context.Context) (*discord.Invite, error)

Delete is like DeleteWithReason but with no particular reason.

func (*Resource) DeleteWithReason

func (r *Resource) DeleteWithReason(ctx context.Context, reason string) (*discord.Invite, error)

DeleteWithReason deletes the invite. Requires the MANAGE_CHANNELS permission. Returns the deleted invite on success. The given reason will be set in the audit log entry for this action.

func (*Resource) Get

func (r *Resource) Get(ctx context.Context, withCounts bool) (*discord.Invite, error)

Get returns the invite. If withCounts is set to true, the returned invite will contain the approximate member counts.