pkgo

package module

Go to main page

Versions in this module

v1

v1.2.0

Oct 14, 2021

Changes in this version

type EditSystemData

+ Color string

type System

+ Color string

v1.1.1

Aug 15, 2021

Changes in this version

+ const ErrAlreadyExists

+ const ErrBadRequest

+ const ErrNotFound

+ const ErrUnauthorized

+ const ErrUnavailable

+ const ErrUnprocessable

+ var BaseURL = "https://api.pluralkit.me/v"

+ var Version = "1"

type CreateMemberData

+ Banner string

type EditMemberData

+ Banner string

type EditSystemData

+ Banner string

type Member

+ Banner string

+ type RequestOption func(*http.Request) error

+ func WithBody(r io.Reader) RequestOption

+ func WithHeader(header http.Header) RequestOption

+ func WithJSONBody(v interface{}) RequestOption

+ func WithURLValues(values url.Values) RequestOption

type Session

+ BaseURL string

+ Client *http.Client

+ RequestOptions []RequestOption

+ func NewWithLimiter(token string, limiter *rate.Limiter) *Session

+ func (s *Session) Request(method, endpoint string, opts ...RequestOption) (response []byte, err error)

+ func (s *Session) RequestJSON(method, endpoint string, v interface{}, opts ...RequestOption) error

type System

+ Banner string

v1.1.0

Aug 11, 2021

v1.0.0

Jun 28, 2021

Changes in this version

type Session

+ Timeout time.Duration

+ func (s *Session) DeleteMember(id string) (err error)

v0

v0.5.0

Jun 13, 2021

Changes in this version

+ var ErrPrivacyInvalid = errors.New("pkgo: invalid privacy setting")

+ type Birthday time.Time

+ func ParseBirthday(in string) (bd Birthday, err error)

+ func (bd *Birthday) UnmarshalJSON(v []byte) error

+ func (bd Birthday) MarshalJSON() (b []byte, err error)

+ func (bd Birthday) Time() time.Time

+ type CreateMemberData struct

+ AvatarPrivacy Privacy

+ AvatarURL string

+ Birthday Birthday

+ BirthdayPrivacy Privacy

+ Color Color

+ Description string

+ DescriptionPrivacy Privacy

+ DisplayName string

+ KeepProxy bool

+ MetadataPrivacy Privacy

+ Name string

+ NamePrivacy Privacy

+ PronounPrivacy Privacy

+ Pronouns string

+ ProxyTags []ProxyTag

+ Visibility Privacy

+ type EditMemberData struct

+ AvatarPrivacy Privacy

+ AvatarURL string

+ Birthday Birthday

+ BirthdayPrivacy Privacy

+ Color Color

+ Description string

+ DescriptionPrivacy Privacy

+ DisplayName string

+ KeepProxy bool

+ MetadataPrivacy Privacy

+ Name string

+ NamePrivacy Privacy

+ PronounPrivacy Privacy

+ Pronouns string

+ ProxyTags []ProxyTag

+ Visibility Privacy

+ type EditSystemData struct

+ AvatarURL string

+ Description string

+ DescriptionPrivacy Privacy

+ FrontHistoryPrivacy Privacy

+ FrontPrivacy Privacy

+ MemberListPrivacy Privacy

+ Name string

+ Tag string

+ Timezone string

+ type InvalidError struct

+ func (e *InvalidError) Error() string

type Member

+ DescriptionPrivacy Privacy

+ func (m Member) String() string

+ func (m Member) Validate() error

type Privacy

+ func (p *Privacy) UnmarshalJSON(v []byte) error

+ func (p Privacy) MarshalJSON() (b []byte, err error)

type Session

+ func New(token string) *Session

+ func NewConfig(c *Config) *Session

+ func (s *Session) Account(id Snowflake) (sys *System, err error)

+ func (s *Session) CreateMember(data CreateMemberData) (m Member, err error)

+ func (s *Session) EditMember(id string, emd EditMemberData) (*Member, error)

+ func (s *Session) EditSystem(psd EditSystemData) (sys *System, err error)

+ func (s *Session) Fronters(id string) (f Front, err error)

+ func (s *Session) Me(force bool) (sys *System, err error)

+ func (s *Session) Member(id string) (m Member, err error)

+ func (s *Session) Members(id string) ([]Member, error)

+ func (s *Session) Message(id Snowflake) (m *Message, err error)

+ func (s *Session) Switches(id string) (switches []Switch, err error)

+ func (s *Session) SwitchesBefore(id string, before time.Time) (switches []Switch, err error)

+ func (s *Session) System(id string) (sys *System, err error)

+ type StatusError struct

+ Code int

+ Status string

+ func (e *StatusError) Error() string

type System

+ DescriptionPrivacy Privacy

v0.4.0

Jun 9, 2021

Changes in this version

+ type Snowflake uint64

+ func ParseSnowflake(str string) (Snowflake, error)

+ func (s *Snowflake) UnmarshalJSON(v []byte) error

+ func (s Snowflake) String() string

v0.3.2

Apr 26, 2021

v0.3.1

Apr 15, 2021

Changes in this version

type Config

+ NoRate bool

type Session

+ NoRate bool

v0.3.0

Feb 4, 2021

Changes in this version

type Session

+ func (s *Session) RateLimit()

v0.2.1

Jan 23, 2021

Changes in this version

+ const BirthdayDDMM

+ const BirthdayMMDD

+ const BirthdayMonthName

+ const BirthdayMonthNameRev

+ const BirthdaySource

+ var ErrInvalidID = errors.New("pkgo: not a 5-character ID")

+ var ErrInvalidSnowflake = errors.New("pkgo: not a valid Discord snowflake")

+ var ErrMsgNotFound = errors.New("pkgo: message not found")

+ var ErrNoToken = errors.New("pkgo: no token in session, can't hit endpoints requiring authentication")

+ var ErrRateLimit = errors.New("pkgo: hit API rate limits")

+ type Color string

+ func (c Color) IsValid() bool

+ func (c Color) ToInt() int64

+ type Config struct

+ Token string

+ type ErrStatusNot200 struct

+ Code int

+ Status string

+ func (e *ErrStatusNot200) Error() string

+ type Front struct

+ Members []Member

+ Timestamp time.Time

+ type Member struct

+ AvatarPrivacy string

+ AvatarURL string

+ Birthday string

+ BirthdayPrivacy string

+ Color Color

+ Created time.Time

+ DescPrivacy string

+ Description string

+ DisplayName string

+ ID string

+ KeepProxy bool

+ MetadataPrivacy string

+ Name string

+ NamePrivacy string

+ PronounPrivacy string

+ Pronouns string

+ ProxyTags []ProxyTag

+ Visibility string

+ func (m *Member) BirthdayString(format string) string

+ func (m *Member) DisplayedName() string

+ func (m *Member) Private(fields ...Privacy) *Member

+ func (m *Member) Public(fields ...Privacy) *Member

+ func (m *Member) SetDescription(desc string) *Member

+ func (m *Member) SetDisplayName(n string) *Member

+ func (m *Member) SetName(n string) *Member

+ func (m *Member) SetPronouns(p string) *Member

+ type Members []Member

+ func (m Members) Len() int

+ func (m Members) Less(i, j int) bool

+ func (m Members) Swap(i, j int)

+ func (m Members) ToMaps() (map[string]string, map[string]string)

+ type Message struct

+ Channel string

+ ID string

+ Member Member

+ Original string

+ Sender string

+ System System

+ Timestamp time.Time

+ type Privacy int

+ const AvatarPrivacy

+ const BirthdayPrivacy

+ const DescPrivacy

+ const MetadataPrivacy

+ const NamePrivacy

+ const PronounPrivacy

+ const Visibility

+ type ProxyTag struct

+ Prefix string

+ Suffix string

+ func (p *ProxyTag) String() string

+ type Session struct

+ func NewSession(c *Config) *Session

+ func (s *Session) GetFronters(id string) (f Front, err error)

+ func (s *Session) GetMembers(id string) (Members, error)

+ func (s *Session) GetMessage(id string) (m *Message, err error)

+ func (s *Session) GetSystem() (sys *System, err error)

+ func (s *Session) GetSystemByID(id string) (sys *System, err error)

+ func (s *Session) GetSystemByUserID(id string) (sys *System, err error)

+ func (s *Session) RegisterSwitch(ids ...string) (err error)

+ func (s *Session) UpdateMember(id string, member *Member) (*Member, error)

+ type Switch struct

+ Members []string

+ Timestamp time.Time

+ type System struct

+ AvatarURL string

+ Created time.Time

+ DescPrivacy string

+ Description string

+ FrontHistoryPrivacy string

+ FrontPrivacy string

+ ID string

+ MemberListPrivacy string

+ Name string

+ Tag string

+ Timezone string

Other modules containing this package

github.com/starshine-sys/pkgo/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL