presence

package
v0.75.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2024 License: MIT Imports: 16 Imported by: 0

Documentation

Index

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 for presence API

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) UsersPresenceHandlerV1 deprecated

Deprecated: 2022-08-10 - Use UsersPresenceHandlerV1Short instead.

UsersPresenceHandlerV1 query users presence Query users presence with given namespace and userIds.

func (*Client) UsersPresenceHandlerV1Short added in v0.8.0

func (a *Client) UsersPresenceHandlerV1Short(params *UsersPresenceHandlerV1Params, authInfo runtime.ClientAuthInfoWriter) (*UsersPresenceHandlerV1OK, error)

UsersPresenceHandlerV1Short query users presence Query users presence with given namespace and userIds.

func (*Client) UsersPresenceHandlerV2 deprecated added in v0.72.0

Deprecated: 2022-08-10 - Use UsersPresenceHandlerV2Short instead.

UsersPresenceHandlerV2 query users presence Query users presence with given namespace and userIds.

func (*Client) UsersPresenceHandlerV2Short added in v0.72.0

func (a *Client) UsersPresenceHandlerV2Short(params *UsersPresenceHandlerV2Params, authInfo runtime.ClientAuthInfoWriter) (*UsersPresenceHandlerV2OK, error)

UsersPresenceHandlerV2Short query users presence Query users presence with given namespace and userIds.

type ClientService

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new presence API client.

type UsersPresenceHandlerV1BadRequest

type UsersPresenceHandlerV1BadRequest struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV1BadRequest handles this case with default header values.

Bad Request

func NewUsersPresenceHandlerV1BadRequest

func NewUsersPresenceHandlerV1BadRequest() *UsersPresenceHandlerV1BadRequest

NewUsersPresenceHandlerV1BadRequest creates a UsersPresenceHandlerV1BadRequest with default headers values

func (*UsersPresenceHandlerV1BadRequest) Error

func (*UsersPresenceHandlerV1BadRequest) GetPayload

func (*UsersPresenceHandlerV1BadRequest) ToJSONString added in v0.25.0

func (o *UsersPresenceHandlerV1BadRequest) ToJSONString() string

type UsersPresenceHandlerV1InternalServerError

type UsersPresenceHandlerV1InternalServerError struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV1InternalServerError handles this case with default header values.

Internal Server Error

func NewUsersPresenceHandlerV1InternalServerError

func NewUsersPresenceHandlerV1InternalServerError() *UsersPresenceHandlerV1InternalServerError

NewUsersPresenceHandlerV1InternalServerError creates a UsersPresenceHandlerV1InternalServerError with default headers values

func (*UsersPresenceHandlerV1InternalServerError) Error

func (*UsersPresenceHandlerV1InternalServerError) GetPayload

func (*UsersPresenceHandlerV1InternalServerError) ToJSONString added in v0.25.0

type UsersPresenceHandlerV1OK

type UsersPresenceHandlerV1OK struct {
	Payload *lobbyclientmodels.HandlersGetUsersPresenceResponse
}

UsersPresenceHandlerV1OK handles this case with default header values.

OK

func NewUsersPresenceHandlerV1OK

func NewUsersPresenceHandlerV1OK() *UsersPresenceHandlerV1OK

NewUsersPresenceHandlerV1OK creates a UsersPresenceHandlerV1OK with default headers values

func (*UsersPresenceHandlerV1OK) Error

func (o *UsersPresenceHandlerV1OK) Error() string

func (*UsersPresenceHandlerV1OK) GetPayload

func (*UsersPresenceHandlerV1OK) ToJSONString added in v0.25.0

func (o *UsersPresenceHandlerV1OK) ToJSONString() string

type UsersPresenceHandlerV1Params

type UsersPresenceHandlerV1Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  namespace

	*/
	Namespace string
	/*CountOnly
	  return only number of players for each availability status

	*/
	CountOnly *bool
	/*UserIds
	  Comma separated value of userIds

	*/
	UserIds string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

UsersPresenceHandlerV1Params contains all the parameters to send to the API endpoint for the users presence handler v1 operation typically these are written to a http.Request

func NewUsersPresenceHandlerV1Params

func NewUsersPresenceHandlerV1Params() *UsersPresenceHandlerV1Params

NewUsersPresenceHandlerV1Params creates a new UsersPresenceHandlerV1Params object with the default values initialized.

func NewUsersPresenceHandlerV1ParamsWithContext

func NewUsersPresenceHandlerV1ParamsWithContext(ctx context.Context) *UsersPresenceHandlerV1Params

NewUsersPresenceHandlerV1ParamsWithContext creates a new UsersPresenceHandlerV1Params object with the default values initialized, and the ability to set a context for a request

func NewUsersPresenceHandlerV1ParamsWithHTTPClient

func NewUsersPresenceHandlerV1ParamsWithHTTPClient(client *http.Client) *UsersPresenceHandlerV1Params

NewUsersPresenceHandlerV1ParamsWithHTTPClient creates a new UsersPresenceHandlerV1Params object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewUsersPresenceHandlerV1ParamsWithTimeout

func NewUsersPresenceHandlerV1ParamsWithTimeout(timeout time.Duration) *UsersPresenceHandlerV1Params

NewUsersPresenceHandlerV1ParamsWithTimeout creates a new UsersPresenceHandlerV1Params object with the default values initialized, and the ability to set a timeout on a request

func (*UsersPresenceHandlerV1Params) SetAuthInfoWriter added in v0.17.0

func (o *UsersPresenceHandlerV1Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetContext

func (o *UsersPresenceHandlerV1Params) SetContext(ctx context.Context)

SetContext adds the context to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetCountOnly

func (o *UsersPresenceHandlerV1Params) SetCountOnly(countOnly *bool)

SetCountOnly adds the countOnly to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetFlightId added in v0.63.0

func (o *UsersPresenceHandlerV1Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*UsersPresenceHandlerV1Params) SetHTTPClient

func (o *UsersPresenceHandlerV1Params) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetHTTPClientTransport added in v0.19.0

func (o *UsersPresenceHandlerV1Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetNamespace

func (o *UsersPresenceHandlerV1Params) SetNamespace(namespace string)

SetNamespace adds the namespace to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetTimeout

func (o *UsersPresenceHandlerV1Params) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) SetUserIds

func (o *UsersPresenceHandlerV1Params) SetUserIds(userIds string)

SetUserIds adds the userIds to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithContext

WithContext adds the context to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithCountOnly

func (o *UsersPresenceHandlerV1Params) WithCountOnly(countOnly *bool) *UsersPresenceHandlerV1Params

WithCountOnly adds the countOnly to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithNamespace

WithNamespace adds the namespace to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithTimeout

WithTimeout adds the timeout to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WithUserIds

WithUserIds adds the userIds to the users presence handler v1 params

func (*UsersPresenceHandlerV1Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type UsersPresenceHandlerV1Reader

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

UsersPresenceHandlerV1Reader is a Reader for the UsersPresenceHandlerV1 structure.

func (*UsersPresenceHandlerV1Reader) ReadResponse

func (o *UsersPresenceHandlerV1Reader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UsersPresenceHandlerV1Unauthorized

type UsersPresenceHandlerV1Unauthorized struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV1Unauthorized handles this case with default header values.

Unauthorized

func NewUsersPresenceHandlerV1Unauthorized

func NewUsersPresenceHandlerV1Unauthorized() *UsersPresenceHandlerV1Unauthorized

NewUsersPresenceHandlerV1Unauthorized creates a UsersPresenceHandlerV1Unauthorized with default headers values

func (*UsersPresenceHandlerV1Unauthorized) Error

func (*UsersPresenceHandlerV1Unauthorized) GetPayload

func (*UsersPresenceHandlerV1Unauthorized) ToJSONString added in v0.25.0

func (o *UsersPresenceHandlerV1Unauthorized) ToJSONString() string

type UsersPresenceHandlerV2BadRequest added in v0.72.0

type UsersPresenceHandlerV2BadRequest struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV2BadRequest handles this case with default header values.

Bad Request

func NewUsersPresenceHandlerV2BadRequest added in v0.72.0

func NewUsersPresenceHandlerV2BadRequest() *UsersPresenceHandlerV2BadRequest

NewUsersPresenceHandlerV2BadRequest creates a UsersPresenceHandlerV2BadRequest with default headers values

func (*UsersPresenceHandlerV2BadRequest) Error added in v0.72.0

func (*UsersPresenceHandlerV2BadRequest) GetPayload added in v0.72.0

func (*UsersPresenceHandlerV2BadRequest) ToJSONString added in v0.72.0

func (o *UsersPresenceHandlerV2BadRequest) ToJSONString() string

type UsersPresenceHandlerV2InternalServerError added in v0.72.0

type UsersPresenceHandlerV2InternalServerError struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV2InternalServerError handles this case with default header values.

Internal Server Error

func NewUsersPresenceHandlerV2InternalServerError added in v0.72.0

func NewUsersPresenceHandlerV2InternalServerError() *UsersPresenceHandlerV2InternalServerError

NewUsersPresenceHandlerV2InternalServerError creates a UsersPresenceHandlerV2InternalServerError with default headers values

func (*UsersPresenceHandlerV2InternalServerError) Error added in v0.72.0

func (*UsersPresenceHandlerV2InternalServerError) GetPayload added in v0.72.0

func (*UsersPresenceHandlerV2InternalServerError) ToJSONString added in v0.72.0

type UsersPresenceHandlerV2OK added in v0.72.0

type UsersPresenceHandlerV2OK struct {
	Payload *lobbyclientmodels.HandlersGetUsersPresenceResponse
}

UsersPresenceHandlerV2OK handles this case with default header values.

OK

func NewUsersPresenceHandlerV2OK added in v0.72.0

func NewUsersPresenceHandlerV2OK() *UsersPresenceHandlerV2OK

NewUsersPresenceHandlerV2OK creates a UsersPresenceHandlerV2OK with default headers values

func (*UsersPresenceHandlerV2OK) Error added in v0.72.0

func (o *UsersPresenceHandlerV2OK) Error() string

func (*UsersPresenceHandlerV2OK) GetPayload added in v0.72.0

func (*UsersPresenceHandlerV2OK) ToJSONString added in v0.72.0

func (o *UsersPresenceHandlerV2OK) ToJSONString() string

type UsersPresenceHandlerV2Params added in v0.72.0

type UsersPresenceHandlerV2Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Body*/
	Body *lobbyclientmodels.ModelRequestUserPresence
	/*Namespace
	  namespace

	*/
	Namespace string
	/*CountOnly
	  return only number of players for each availability status

	*/
	CountOnly *bool

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

UsersPresenceHandlerV2Params contains all the parameters to send to the API endpoint for the users presence handler v2 operation typically these are written to a http.Request

func NewUsersPresenceHandlerV2Params added in v0.72.0

func NewUsersPresenceHandlerV2Params() *UsersPresenceHandlerV2Params

NewUsersPresenceHandlerV2Params creates a new UsersPresenceHandlerV2Params object with the default values initialized.

func NewUsersPresenceHandlerV2ParamsWithContext added in v0.72.0

func NewUsersPresenceHandlerV2ParamsWithContext(ctx context.Context) *UsersPresenceHandlerV2Params

NewUsersPresenceHandlerV2ParamsWithContext creates a new UsersPresenceHandlerV2Params object with the default values initialized, and the ability to set a context for a request

func NewUsersPresenceHandlerV2ParamsWithHTTPClient added in v0.72.0

func NewUsersPresenceHandlerV2ParamsWithHTTPClient(client *http.Client) *UsersPresenceHandlerV2Params

NewUsersPresenceHandlerV2ParamsWithHTTPClient creates a new UsersPresenceHandlerV2Params object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewUsersPresenceHandlerV2ParamsWithTimeout added in v0.72.0

func NewUsersPresenceHandlerV2ParamsWithTimeout(timeout time.Duration) *UsersPresenceHandlerV2Params

NewUsersPresenceHandlerV2ParamsWithTimeout creates a new UsersPresenceHandlerV2Params object with the default values initialized, and the ability to set a timeout on a request

func (*UsersPresenceHandlerV2Params) SetAuthInfoWriter added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetBody added in v0.72.0

SetBody adds the body to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetContext added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetContext(ctx context.Context)

SetContext adds the context to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetCountOnly added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetCountOnly(countOnly *bool)

SetCountOnly adds the countOnly to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetFlightId added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*UsersPresenceHandlerV2Params) SetHTTPClient added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetHTTPClientTransport added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetNamespace added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetNamespace(namespace string)

SetNamespace adds the namespace to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) SetTimeout added in v0.72.0

func (o *UsersPresenceHandlerV2Params) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithBody added in v0.72.0

WithBody adds the body to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithContext added in v0.72.0

WithContext adds the context to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithCountOnly added in v0.72.0

func (o *UsersPresenceHandlerV2Params) WithCountOnly(countOnly *bool) *UsersPresenceHandlerV2Params

WithCountOnly adds the countOnly to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithHTTPClient added in v0.72.0

WithHTTPClient adds the HTTPClient to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithNamespace added in v0.72.0

WithNamespace adds the namespace to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WithTimeout added in v0.72.0

WithTimeout adds the timeout to the users presence handler v2 params

func (*UsersPresenceHandlerV2Params) WriteToRequest added in v0.72.0

WriteToRequest writes these params to a swagger request

type UsersPresenceHandlerV2Reader added in v0.72.0

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

UsersPresenceHandlerV2Reader is a Reader for the UsersPresenceHandlerV2 structure.

func (*UsersPresenceHandlerV2Reader) ReadResponse added in v0.72.0

func (o *UsersPresenceHandlerV2Reader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UsersPresenceHandlerV2Unauthorized added in v0.72.0

type UsersPresenceHandlerV2Unauthorized struct {
	Payload *lobbyclientmodels.RestapiErrorResponseBody
}

UsersPresenceHandlerV2Unauthorized handles this case with default header values.

Unauthorized

func NewUsersPresenceHandlerV2Unauthorized added in v0.72.0

func NewUsersPresenceHandlerV2Unauthorized() *UsersPresenceHandlerV2Unauthorized

NewUsersPresenceHandlerV2Unauthorized creates a UsersPresenceHandlerV2Unauthorized with default headers values

func (*UsersPresenceHandlerV2Unauthorized) Error added in v0.72.0

func (*UsersPresenceHandlerV2Unauthorized) GetPayload added in v0.72.0

func (*UsersPresenceHandlerV2Unauthorized) ToJSONString added in v0.72.0

func (o *UsersPresenceHandlerV2Unauthorized) ToJSONString() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL