users

Documentation

Index

• Constants
• type Client
  • func (c *Client) Me() (*types.User, error)
• type MeResponse
• type MeResponseData
• type MeVariables
  • func NewMeVariables() MeVariables
• type UserService
  • func NewClient(endpointURL string, httpClient web.HTTPClient, authClient auth.AuthClient) (UserService, error)

Constants

const (
	QueryMe       = "me"
	MeVarTemplate = ``
)

Types

type Client

type Client struct {
	web.SatConClient
}

Client is an implementation of a satcon client.

func (*Client) Me

func (c *Client) Me() (*types.User, error)

Channel returns channel specified by channeUuid

type MeResponse

type MeResponse struct {
	Data *MeResponseData `json:"data,omitempty"`
}

MeResponse user data

type MeResponseData

type MeResponseData struct {
	User *types.User `json:"me,omitempty"`
}

MeResponseData user details

type MeVariables

type MeVariables struct {
	actions.GraphQLQuery
}

MeVariables to query user

func NewMeVariables

func NewMeVariables() MeVariables

NewMeVariables returns required query variables

type UserService

type UserService interface {
	Me() (*types.User, error)
}

UserService is the interface used to perform all user-centric actions.

func NewClient

func NewClient(endpointURL string, httpClient web.HTTPClient, authClient auth.AuthClient) (UserService, error)

NewClient returns a configured instance of ClusterService which can then be used to perform cluster queries against Satellite Config.