rogo

Documentation

Index

• type BaseGroup
• type BaseMember
  • func (m *BaseMember) GetUser(c *Client) (*User, error)
• type BaseRole
• type BaseUser
  • func (u *BaseUser) GetUser(c *Client) (*User, error)
• type Client
  • func NewClient(token string) *Client
  • func (c *Client) GetGroup(groupId int) (*Group, error)
  • func (c *Client) GetUser(userId int) (*User, error)
• type Data
• type Error
• type Group
  • func (g *Group) Exile(userId int) error
  • func (g *Group) GetMembers() (*Pagination[BaseMember], error)
  • func (g *Group) GetRole(roleNumber int) (*BaseRole, error)
  • func (g *Group) GetRoles() ([]BaseRole, error)
  • func (g *Group) Join() error
  • func (g *Group) SetRank(userId int, roleId int) error
• type GroupUser
• type HasClient
• type MinimalUser
• type Pagination
  • func (p *Pagination[T]) Next() (*Pagination[T], error)
  • func (p *Pagination[T]) Previous() (*Pagination[T], error)
• type Roles
• type User

Types

type BaseGroup

type BaseGroup struct {
	Id          int       `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Owner       GroupUser `json:"owner"`
	Shout       struct {
		Body    string    `json:"body"`
		Poster  GroupUser `json:"poster"`
		Created time.Time `json:"created"`
		Updated time.Time `json:"updated"`
	}
	Count    int  `json:"memberCount"`
	Locked   bool `json:"isLocked"`
	Verified bool `json:"hasVerifiedBadge"`
}

type BaseMember

type BaseMember struct {
	User GroupUser `json:"user"`
	Role BaseRole  `json:"role"`
}

func (*BaseMember) GetUser

func (m *BaseMember) GetUser(c *Client) (*User, error)

type BaseRole

type BaseRole struct {
	Id          int    `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Rank        int    `json:"rank"`
	Count       int    `json:"memberCount"`
}

type BaseUser

type BaseUser struct {
	MinimalUser
	Verified       bool `json:"hasVerifiedBadge"`
	MembershipType int  `json:"buildersClubMembershipType"`
}

func (*BaseUser) GetUser

func (u *BaseUser) GetUser(c *Client) (*User, error)

type Client

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

func NewClient

func NewClient(token string) *Client

func (*Client) GetGroup

func (c *Client) GetGroup(groupId int) (*Group, error)

func (*Client) GetUser

func (c *Client) GetUser(userId int) (*User, error)

type Data

type Data[T any] struct {
	Data []T `json:"data"`
}

type Error

type Error struct {
	Errors []struct {
		Code    int    `json:"code"`
		Message string `json:"message"`
	}
}

type Group

type Group struct {
	BaseGroup
	// contains filtered or unexported fields
}

func (*Group) Exile

func (g *Group) Exile(userId int) error

func (*Group) GetMembers

func (g *Group) GetMembers() (*Pagination[BaseMember], error)

func (*Group) GetRole

func (g *Group) GetRole(roleNumber int) (*BaseRole, error)

func (*Group) GetRoles

func (g *Group) GetRoles() ([]BaseRole, error)

func (*Group) Join

func (g *Group) Join() error

func (*Group) SetRank

func (g *Group) SetRank(userId int, roleId int) error

type GroupUser

type GroupUser struct {
	BaseUser
	Id   int    `json:"userId"`
	Name string `json:"username"`
}

type HasClient

type HasClient interface {
	// contains filtered or unexported methods
}

type MinimalUser

type MinimalUser struct {
	Id          int    `json:"id"`
	Name        string `json:"name"`
	DisplayName string `json:"displayName"`
}

MinimalUser represents a minimal user object. This is used for authentication purposes.

type Pagination

type Pagination[T any] struct {
	Data []T `json:"data"`

	NextCursor     string `json:"nextPageCursor"`
	PreviousCursor string `json:"previousPageCursor"`
	URL            string
	// contains filtered or unexported fields
}

func (*Pagination[T]) Next

func (p *Pagination[T]) Next() (*Pagination[T], error)

func (*Pagination[T]) Previous

func (p *Pagination[T]) Previous() (*Pagination[T], error)

type Roles

type Roles struct {
	GroupId int        `json:"groupId"`
	Roles   []BaseRole `json:"roles"`
}

type User

type User struct {
	BaseUser

	Description string    `json:"description"`
	Created     time.Time `json:"created"`
	Banned      bool      `json:"isBanned"`
	// contains filtered or unexported fields
}