api

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2022 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ApiUrl     = "https://discord.com/api"
	ApiVersion = "v10"
	FullApiUrl = ApiUrl + "/" + ApiVersion
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ChannelMessagesQuery 

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

func NewChannelMessagesQuery 

func NewChannelMessagesQuery(client *Client, channel snowflake.ID) ChannelMessagesQuery

func (ChannelMessagesQuery) After 

func (v ChannelMessagesQuery) After(ctx context.Context, id snowflake.ID, limit uint16) (msgs []discord.Message, err error)

func (ChannelMessagesQuery) Around 

func (v ChannelMessagesQuery) Around(id snowflake.ID, limit uint16) (msgs []discord.Message, err error)

func (ChannelMessagesQuery) Before 

func (v ChannelMessagesQuery) Before(ctx context.Context, id snowflake.ID, limit uint16) (msgs []discord.Message, err error)

func (ChannelMessagesQuery) ID 

func (v ChannelMessagesQuery) ID() snowflake.ID

func (ChannelMessagesQuery) Latest 

func (v ChannelMessagesQuery) Latest(limit uint16) (msgs []discord.Message, err error)

type ChannelQuery 

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

func NewChannelQuery 

func NewChannelQuery(client *Client, id snowflake.ID) *ChannelQuery

func (ChannelQuery) AddMember 

func (c ChannelQuery) AddMember(id snowflake.ID) error

func (ChannelQuery) Bulk 

func (c ChannelQuery) Bulk(ids []snowflake.ID) error

func (ChannelQuery) CreateWebhook added in v0.1.3 

func (c ChannelQuery) CreateWebhook(opts discord.WebhookCreate) (res *discord.Webhook, err error)

func (ChannelQuery) Delete 

func (c ChannelQuery) Delete() error

func (ChannelQuery) Edit 

func (c ChannelQuery) Edit() discord.UpdateChannelTypeSelector

func (ChannelQuery) Follow 

func (c ChannelQuery) Follow(target snowflake.ID) error

func (ChannelQuery) Get 

func (c ChannelQuery) Get() (ch *discord.Channel, err error)

func (ChannelQuery) GetThreadMember 

func (c ChannelQuery) GetThreadMember(id snowflake.ID) (tm *discord.ThreadMember, err error)

func (ChannelQuery) ID 

func (c ChannelQuery) ID() snowflake.ID

func (ChannelQuery) Invites 

func (c ChannelQuery) Invites() (invites []discord.InviteWithMeta, err error)

func (ChannelQuery) Join 

func (c ChannelQuery) Join() error

func (ChannelQuery) Leave 

func (c ChannelQuery) Leave() error

func (ChannelQuery) Message 

func (c ChannelQuery) Message(id snowflake.ID) discord.MessageQuery

func (ChannelQuery) Messages 

func (c ChannelQuery) Messages() discord.ChannelMessagesQuery

func (*ChannelQuery) NoAPI 

func (e *ChannelQuery) NoAPI() V

func (*ChannelQuery) NoCache 

func (e *ChannelQuery) NoCache() V

func (ChannelQuery) Pinned 

func (c ChannelQuery) Pinned() (msg []discord.Message, err error)

func (*ChannelQuery) Reason 

func (e *ChannelQuery) Reason(str string) V

func (ChannelQuery) RemoveMember 

func (c ChannelQuery) RemoveMember(id snowflake.ID) error

func (ChannelQuery) SendMessage 

func (c ChannelQuery) SendMessage() discord.CreateMessageBuilder

func (ChannelQuery) Stage 

func (c ChannelQuery) Stage() discord.StageQuery

func (ChannelQuery) StartForumThread 

func (c ChannelQuery) StartForumThread(name string) discord.CreateForumMessageBuilder

func (ChannelQuery) StartThread 

func (c ChannelQuery) StartThread(name string) discord.CreateThreadTypeSelector

func (ChannelQuery) Webhooks added in v0.1.3 

func (c ChannelQuery) Webhooks() (res []discord.Webhook, err error)

type Client 

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

func NewClient 

func NewClient(token string, options ...Option) *Client

func (*Client) Channel 

func (v *Client) Channel(id snowflake.ID) discord.ChannelQuery

func (*Client) CurrentUser 

func (v *Client) CurrentUser() (user *discord.User, err error)

func (*Client) Do 

func (v *Client) Do(req *fasthttp.Request, options ...Option) (*fasthttp.Response, error)

func (*Client) DoBytes 

func (v *Client) DoBytes(req *fasthttp.Request, options ...Option) ([]byte, error)

func (*Client) DoNoResp 

func (v *Client) DoNoResp(req *fasthttp.Request, options ...Option) error

func (*Client) DoResult 

func (v *Client) DoResult(req *fasthttp.Request, result any, options ...Option) error

func (*Client) GatewayURL 

func (v *Client) GatewayURL() (url string, err error)

func (*Client) Guild 

func (v *Client) Guild(id snowflake.ID) discord.GuildQuery

func (*Client) Log 

func (v *Client) Log() golog.Logger

func (*Client) LowLevel 

func (v *Client) LowLevel() discord.LowLevelClientQuery

func (*Client) New 

func (v *Client) New(auth bool) *fasthttp.Request

func (*Client) SessionData 

func (v *Client) SessionData() (data SessionInfo, err error)

func (*Client) User 

func (v *Client) User(id snowflake.ID) discord.UserQuery

func (*Client) Webhook 

func (v *Client) Webhook(id snowflake.ID, token string) discord.WebhookQuery

type GuildQuery 

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

func NewGuildQuery 

func NewGuildQuery(client *Client, id snowflake.ID) *GuildQuery

func (GuildQuery) ActiveThreads 

func (v GuildQuery) ActiveThreads() (threads []discord.Channel, err error)

func (GuildQuery) Channels 

func (v GuildQuery) Channels() (channels []discord.Channel, err error)

func (GuildQuery) CreateChannel 

func (v GuildQuery) CreateChannel(name string) discord.GuildChannelBuilder

func (GuildQuery) CreateRole 

func (v GuildQuery) CreateRole() discord.RoleBuilder

func (GuildQuery) Delete 

func (v GuildQuery) Delete() error

func (GuildQuery) Edit 

func (v GuildQuery) Edit() discord.GuildBuilder

func (GuildQuery) Get 

func (v GuildQuery) Get() (guild *discord.Guild, err error)

func (GuildQuery) ID 

func (v GuildQuery) ID() snowflake.ID

func (GuildQuery) Invites 

func (v GuildQuery) Invites() (invites []discord.InviteWithMeta, err error)

func (GuildQuery) Member 

func (v GuildQuery) Member(id snowflake.ID) discord.GuildMemberQuery

func (GuildQuery) Members 

func (v GuildQuery) Members(limit int, after snowflake.ID) (members []discord.MemberWithUser, err error)

func (*GuildQuery) NoAPI 

func (e *GuildQuery) NoAPI() V

func (*GuildQuery) NoCache 

func (e *GuildQuery) NoCache() V

func (*GuildQuery) Reason 

func (e *GuildQuery) Reason(str string) V

func (GuildQuery) Role 

func (v GuildQuery) Role(id snowflake.ID) discord.RoleQuery

func (GuildQuery) Roles 

func (v GuildQuery) Roles() (roles []discord.Role, err error)

func (GuildQuery) Search 

func (v GuildQuery) Search(query string, limit uint16) (members []discord.MemberWithUser, err error)

func (GuildQuery) SetCurrentNick 

func (v GuildQuery) SetCurrentNick(nick string) (err error)

func (GuildQuery) UpdateChannelPositions 

func (v GuildQuery) UpdateChannelPositions(positions *discord.GuildChannelPositionsBuilder) error

func (GuildQuery) UpdateRolePositions 

func (v GuildQuery) UpdateRolePositions(roles discord.RolePositions) error

func (GuildQuery) VoiceStates 

func (v GuildQuery) VoiceStates() (states discord.Slice[discord.VoiceState], err error)

type MemberQuery 

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

func NewMemberQuery 

func NewMemberQuery(client *Client, guild snowflake.ID, id snowflake.ID) *MemberQuery

func (MemberQuery) AddRole 

func (v MemberQuery) AddRole(role snowflake.ID) (err error)

func (MemberQuery) Ban 

func (v MemberQuery) Ban(days uint8) (err error)

func (MemberQuery) Edit 

func (v MemberQuery) Edit() discord.UpdateGuildMemberBuilder

func (MemberQuery) Get 

func (v MemberQuery) Get() (member *discord.MemberWithUser, err error)

func (MemberQuery) GuildID 

func (v MemberQuery) GuildID() snowflake.ID

func (MemberQuery) ID 

func (v MemberQuery) ID() snowflake.ID

func (MemberQuery) Kick 

func (v MemberQuery) Kick() (err error)

func (*MemberQuery) NoAPI 

func (e *MemberQuery) NoAPI() V

func (*MemberQuery) NoCache 

func (e *MemberQuery) NoCache() V

func (MemberQuery) Permissions 

func (v MemberQuery) Permissions() (perm permissions.Permission, err error)

func (MemberQuery) PermissionsIn 

func (v MemberQuery) PermissionsIn(channel snowflake.ID) (perm permissions.Permission, err error)

func (*MemberQuery) Reason 

func (e *MemberQuery) Reason(str string) V

func (MemberQuery) RemoveRole 

func (v MemberQuery) RemoveRole(role snowflake.ID) (err error)

func (MemberQuery) Unban 

func (v MemberQuery) Unban() (err error)

func (MemberQuery) VoiceState 

func (v MemberQuery) VoiceState() (state *discord.VoiceState, err error)

type MessageQuery 

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

func NewMessageQuery 

func NewMessageQuery(client *Client, channel, id snowflake.ID) *MessageQuery

func (MessageQuery) ChannelID 

func (m MessageQuery) ChannelID() snowflake.ID

func (MessageQuery) CrossPost 

func (m MessageQuery) CrossPost() error

func (MessageQuery) Delete 

func (m MessageQuery) Delete() (err error)

func (MessageQuery) Edit 

func (m MessageQuery) Edit() discord.MessageBuilder

func (MessageQuery) Get 

func (m MessageQuery) Get() (msg *discord.Message, err error)

func (MessageQuery) ID 

func (m MessageQuery) ID() snowflake.ID

func (*MessageQuery) NoAPI 

func (e *MessageQuery) NoAPI() V

func (*MessageQuery) NoCache 

func (e *MessageQuery) NoCache() V

func (MessageQuery) Pin 

func (m MessageQuery) Pin() error

func (MessageQuery) React 

func (m MessageQuery) React(emoji string) error

func (MessageQuery) Reaction 

func (m MessageQuery) Reaction(emoji string) discord.MessageReactionQuery

func (*MessageQuery) Reason 

func (e *MessageQuery) Reason(str string) V

func (MessageQuery) RemoveAllReactions 

func (m MessageQuery) RemoveAllReactions() (err error)

func (MessageQuery) StartThread 

func (m MessageQuery) StartThread(name string) discord.CreateThreadChannelBuilder

func (MessageQuery) UnPin 

func (m MessageQuery) UnPin() error

type Option 

type Option func(v *RequestData)

func WithAuthHeaderPrefix 

func WithAuthHeaderPrefix(prefix string) Option

func WithLogger 

func WithLogger(log golog.Logger) Option

func WithPrefix 

func WithPrefix(prefix string) Option

func WithRetries 

func WithRetries(retries uint8) Option

func WithRetryDelay 

func WithRetryDelay(delay time.Duration) Option

func WithTimeout 

func WithTimeout(timeout time.Duration) Option

type ReactionQuery 

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

func NewReactionQuery 

func NewReactionQuery(client *Client, channel, message snowflake.ID, emoji string) *ReactionQuery

func (ReactionQuery) After 

func (r ReactionQuery) After(limit uint64, after snowflake.ID) (users []discord.User, err error)

func (ReactionQuery) All 

func (r ReactionQuery) All(limit uint64) (users []discord.User, err error)

func (ReactionQuery) Channel 

func (r ReactionQuery) Channel() snowflake.ID

func (ReactionQuery) Emoji 

func (r ReactionQuery) Emoji() string

func (ReactionQuery) Message 

func (r ReactionQuery) Message() snowflake.ID

func (*ReactionQuery) NoAPI 

func (e *ReactionQuery) NoAPI() V

func (*ReactionQuery) NoCache 

func (e *ReactionQuery) NoCache() V

func (ReactionQuery) Range 

func (r ReactionQuery) Range(limit uint64, after snowflake.ID) (users []discord.User, err error)

func (*ReactionQuery) Reason 

func (e *ReactionQuery) Reason(str string) V

func (ReactionQuery) Remove 

func (r ReactionQuery) Remove(userID snowflake.ID) (err error)

func (ReactionQuery) RemoveAll 

func (r ReactionQuery) RemoveAll() (err error)

func (ReactionQuery) RemoveOwn 

func (r ReactionQuery) RemoveOwn() (err error)

type RequestData 

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

type RoleQuery 

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

func NewRoleQuery 

func NewRoleQuery(client *Client, guild snowflake.ID, id snowflake.ID) *RoleQuery

func (RoleQuery) Delete 

func (r RoleQuery) Delete() error

func (RoleQuery) Edit 

func (r RoleQuery) Edit() discord.RoleBuilder

func (RoleQuery) Get 

func (r RoleQuery) Get() (role *discord.Role, err error)

func (*RoleQuery) NoAPI 

func (e *RoleQuery) NoAPI() V

func (*RoleQuery) NoCache 

func (e *RoleQuery) NoCache() V

func (*RoleQuery) Reason 

func (e *RoleQuery) Reason(str string) V

type SessionInfo 

type SessionInfo struct {
	Url    string `json:"url"`
	Shards uint16 `json:"shards"`
	Limits struct {
		Total          int `json:"total"`
		Remaining      int `json:"remaining"`
		ResetAfter     int `json:"reset_after"`
		MaxConcurrency int `json:"max_concurrency"`
	} `json:"session_start_limit"`
}

type StageQuery 

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

func NewStageQuery 

func NewStageQuery(client *Client, id snowflake.ID) *StageQuery

func (StageQuery) Create 

func (s StageQuery) Create(topic string, notify bool) (stage *discord.StageInstance, err error)

func (StageQuery) Delete 

func (s StageQuery) Delete() error

func (StageQuery) Get 

func (s StageQuery) Get() (stage *discord.StageInstance, err error)

func (StageQuery) Modify 

func (s StageQuery) Modify(topic string) (stage *discord.StageInstance, err error)

func (*StageQuery) NoAPI 

func (e *StageQuery) NoAPI() V

func (*StageQuery) NoCache 

func (e *StageQuery) NoCache() V

func (*StageQuery) Reason 

func (e *StageQuery) Reason(str string) V

type UserQuery 

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

func NewUserQuery 

func NewUserQuery(client *Client, id snowflake.ID) *UserQuery

func (UserQuery) CreateDM 

func (u UserQuery) CreateDM() (channel *discord.Channel, err error)

func (UserQuery) Get 

func (u UserQuery) Get() (user *discord.User, err error)

func (UserQuery) ID 

func (u UserQuery) ID() snowflake.ID

func (*UserQuery) NoAPI 

func (e *UserQuery) NoAPI() V

func (*UserQuery) NoCache 

func (e *UserQuery) NoCache() V

func (*UserQuery) Reason 

func (e *UserQuery) Reason(str string) V

func (UserQuery) Send 

func (u UserQuery) Send() (bld discord.CreateMessageBuilder, err error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.