group

Documentation

Overview

Package group provides functions to interact with Roblox groups.

Index

• type Group
  • func Get(groupId int, acc *account.Account) (*Group, error)
  • func (c Group) ChangeRank(UserId int, Change int) (Role, Role, error)
  • func (c Group) Demote(UserID int) (Role, Role, error)
  • func (c Group) Exile(UserID int) error
  • func (c Group) GetGroupPosts(limit ...int) (<-chan []Post, <-chan error, error)
  • func (c Group) GetGroupRoles() ([]Role, error)
  • func (c Group) GetJoinRequests(limit ...int) (<-chan []JoinRequest, <-chan error, error)
  • func (c Group) GetRoleInGroup(id int) (Role, error)
  • func (c Group) GetShout() (*Shout, error)
  • func (c Group) PostShout(shout string) error
  • func (c Group) Promote(UserID int) (Role, Role, error)
  • func (c Group) SetRank(UserID, Id int) error
• type JoinRequest
  • func (r JoinRequest) Accept() error
  • func (r JoinRequest) Decline() error
• type Post
• type Requester
• type Role
• type Shout
• type UserGroupRelation

Types

type Group

type Group struct {
	Description        string     `json:"description"`
	Id                 int        `json:"id"`
	IsBuildersClubOnly bool       `json:"isBuildersClubOnly"`
	MemberCount        int        `json:"memberCount"`
	Name               string     `json:"name"`
	PublicEntryAllowed bool       `json:"publicEntryAllowed"`
	Shout              *Shout     `json:"shout"`
	Owner              *user.User `json:"owner"`

	BotAccount *account.Account `json:"-"` // Don't encode account
}

The Group struct provides information about a Roblox group.

func Get

func Get(groupId int, acc *account.Account) (*Group, error)

The Get function retrieves info about a Roblox group.

func (Group) ChangeRank

func (c Group) ChangeRank(UserId int, Change int) (Role, Role, error)

func (Group) Demote

func (c Group) Demote(UserID int) (Role, Role, error)

func (Group) Exile

func (c Group) Exile(UserID int) error

func (Group) GetGroupPosts

func (c Group) GetGroupPosts(limit ...int) (<-chan []Post, <-chan error, error)

func (Group) GetGroupRoles

func (c Group) GetGroupRoles() ([]Role, error)

func (Group) GetJoinRequests

func (c Group) GetJoinRequests(limit ...int) (<-chan []JoinRequest, <-chan error, error)

func (Group) GetRoleInGroup

func (c Group) GetRoleInGroup(id int) (Role, error)

func (Group) GetShout

func (c Group) GetShout() (*Shout, error)

func (Group) PostShout

func (c Group) PostShout(shout string) error

func (Group) Promote

func (c Group) Promote(UserID int) (Role, Role, error)

func (Group) SetRank

func (c Group) SetRank(UserID, Id int) error

type JoinRequest

type JoinRequest struct {
	Group     *Group
	Created   time.Time `json:"created"`
	Requester Requester `json:"requester"`
}

JoinRequest represents a user who is pending to join a group

func (JoinRequest) Accept

func (r JoinRequest) Accept() error

func (JoinRequest) Decline

func (r JoinRequest) Decline() error

type Post

type Post struct {
	Id      int          `json:"id"`
	Poster  interiorPost `json:"poster"`
	Body    string       `json:"body"`
	Created time.Time    `json:"created"`
	Updated time.Time    `json:"updated"`
	Group   *Group
}

Post is the decoded value of a Post on a group wall

type Requester

type Requester struct {
	Username    string `json:"username"`
	DisplayName string `json:"displayName"`
	UserID      int    `json:"userId"`
}

Requester represents a subsection of a JoinRequest

type Role

type Role struct {
	Id          int    `json:"id"`
	Name        string `json:"name"`
	Rank        int    `json:"rank"`
	MemberCount int    `json:"memberCount"`
}

Role represents a Group Role

type Shout

type Shout struct {
	Content string `json:"body"`
	Created string `json:"created"`
	Updated string `json:"updated"`
	Poster  *user.User
}

The Shout struct provides information about a group shout.

type UserGroupRelation

type UserGroupRelation struct {
	RobloxGroup Group `json:"group"`
	RobloxRole  Role  `json:"role"`
}

UserGroupRelation represents a user's Role in a Group