Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeBase64 ¶
DecodeBase64 decodes a base64 string
func InferPersonIDFromUUID ¶
InferPersonIDFromUUID converts a UUID to a Hydra ID without a network call
Types ¶
type BatchResponse ¶
type BatchResponse struct {
Items []Person `json:"items"`
NotFoundIDs []string `json:"notFoundIds,omitempty"`
}
BatchResponse represents the response from a batch people request
type Batcher ¶
type Batcher struct {
// contains filtered or unexported fields
}
Batcher manages batched requests for people
func NewBatcher ¶
NewBatcher creates a new people batcher
func (*Batcher) BatchRequest ¶
BatchRequest processes a batch of requests immediately
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the people API client
func (*Client) List ¶
func (c *Client) List(options *ListOptions) (*PeoplePage, error)
List returns a list of people
type Config ¶
type Config struct {
// BatcherWait is the time to wait before processing a batch request
BatcherWait time.Duration
// MaxBatchCalls is the maximum number of batch calls to make at once
MaxBatchCalls int
// MaxBatchWait is the maximum time to wait before processing a batch request
MaxBatchWait time.Duration
// ShowAllTypes is a flag that requires the API to send every type field,
// even if the type is not "person" (e.g.: SX10, webhook_integration, etc.)
ShowAllTypes bool
}
Config holds the configuration for the People plugin
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns the default configuration for the People plugin
type ListOptions ¶
type ListOptions struct {
Email string `url:"email,omitempty"`
DisplayName string `url:"displayName,omitempty"`
IDs []string `url:"-"` // Handled separately in the List method
Max int `url:"max,omitempty"`
ShowAllTypes bool `url:"showAllTypes,omitempty"`
}
ListOptions contains the options for listing people
type PeoplePage ¶
PeoplePage represents a paginated list of people
type Person ¶
type Person struct {
ID string `json:"id"`
Emails []string `json:"emails"`
DisplayName string `json:"displayName"`
NickName string `json:"nickName,omitempty"`
FirstName string `json:"firstName,omitempty"`
LastName string `json:"lastName,omitempty"`
Avatar string `json:"avatar,omitempty"`
OrgID string `json:"orgId,omitempty"`
Roles []string `json:"roles,omitempty"`
Licenses []string `json:"licenses,omitempty"`
Created time.Time `json:"created,omitempty"`
Status string `json:"status,omitempty"`
Type string `json:"type,omitempty"`
}
Person represents a Webex person
Click to show internal directories.
Click to hide internal directories.