Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(membership *Membership) (*Membership, error)
- func (c *Client) Delete(membershipID string) error
- func (c *Client) Get(membershipID string) (*Membership, error)
- func (c *Client) List(options *ListOptions) (*MembershipsPage, error)
- func (c *Client) Update(membershipID string, membership *Membership) (*Membership, error)
- type Config
- type ListOptions
- type Membership
- type MembershipsPage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the memberships API client
func (*Client) Create ¶
func (c *Client) Create(membership *Membership) (*Membership, error)
Create adds a person to a room
func (*Client) Get ¶
func (c *Client) Get(membershipID string) (*Membership, error)
Get returns a single membership by ID
func (*Client) List ¶
func (c *Client) List(options *ListOptions) (*MembershipsPage, error)
List returns a list of memberships
func (*Client) Update ¶
func (c *Client) Update(membershipID string, membership *Membership) (*Membership, error)
Update updates an existing membership
type Config ¶
type Config struct {
}
Config holds the configuration for the Memberships plugin
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns the default configuration for the Memberships plugin
type ListOptions ¶
type ListOptions struct {
RoomID string `url:"roomId,omitempty"`
PersonID string `url:"personId,omitempty"`
PersonEmail string `url:"personEmail,omitempty"`
Max int `url:"max,omitempty"`
}
ListOptions contains the options for listing memberships
type Membership ¶
type Membership struct {
ID string `json:"id,omitempty"`
RoomID string `json:"roomId,omitempty"`
PersonID string `json:"personId,omitempty"`
PersonEmail string `json:"personEmail,omitempty"`
PersonDisplayName string `json:"personDisplayName,omitempty"`
PersonOrgID string `json:"personOrgId,omitempty"`
IsModerator bool `json:"isModerator,omitempty"`
IsMonitor bool `json:"isMonitor,omitempty"`
IsRoomHidden bool `json:"isRoomHidden,omitempty"`
Created *time.Time `json:"created,omitempty"`
RoomType string `json:"roomType,omitempty"`
LastSeenID string `json:"lastSeenId,omitempty"`
LastSeenDate *time.Time `json:"lastSeenDate,omitempty"`
}
Membership represents a Webex membership
type MembershipsPage ¶
type MembershipsPage struct {
Items []Membership `json:"items"`
*webexsdk.Page
}
MembershipsPage represents a paginated list of memberships
Click to show internal directories.
Click to hide internal directories.