Documentation
¶
Index ¶
- type Client
- func (a *Client) RegisterXblSessions(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, *RegisterXblSessionsBadRequest, error)deprecated
- func (a *Client) RegisterXblSessionsShort(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientService
- type RegisterXblSessionsBadRequest
- type RegisterXblSessionsOK
- type RegisterXblSessionsParams
- func NewRegisterXblSessionsParams() *RegisterXblSessionsParams
- func NewRegisterXblSessionsParamsWithContext(ctx context.Context) *RegisterXblSessionsParams
- func NewRegisterXblSessionsParamsWithHTTPClient(client *http.Client) *RegisterXblSessionsParams
- func NewRegisterXblSessionsParamsWithTimeout(timeout time.Duration) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *RegisterXblSessionsParams) SetBody(body *platformclientmodels.XblUserSessionRequest)
- func (o *RegisterXblSessionsParams) SetContext(ctx context.Context)
- func (o *RegisterXblSessionsParams) SetFlightId(flightId string)
- func (o *RegisterXblSessionsParams) SetHTTPClient(client *http.Client)
- func (o *RegisterXblSessionsParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *RegisterXblSessionsParams) SetNamespace(namespace string)
- func (o *RegisterXblSessionsParams) SetTimeout(timeout time.Duration)
- func (o *RegisterXblSessionsParams) SetUserID(userID string)
- func (o *RegisterXblSessionsParams) WithBody(body *platformclientmodels.XblUserSessionRequest) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WithContext(ctx context.Context) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WithHTTPClient(client *http.Client) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WithNamespace(namespace string) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WithTimeout(timeout time.Duration) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WithUserID(userID string) *RegisterXblSessionsParams
- func (o *RegisterXblSessionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type RegisterXblSessionsReader
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 session platform API
func (*Client) RegisterXblSessions
deprecated
func (a *Client) RegisterXblSessions(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, *RegisterXblSessionsBadRequest, error)
Deprecated: 2022-08-10 - Use RegisterXblSessionsShort instead.
RegisterXblSessions register/update a session This API is used to register/update a session on xbox.
Other detail info:
- Required permission : resource=ADMIN:NAMESPACE:{namespace}:USER:{userId}:INTEGRATION, action=4 (UPDATE)
func (*Client) RegisterXblSessionsShort ¶
func (a *Client) RegisterXblSessionsShort(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, error)
RegisterXblSessionsShort register/update a session This API is used to register/update a session on xbox.
Other detail info:
- Required permission : resource=ADMIN:NAMESPACE:{namespace}:USER:{userId}:INTEGRATION, action=4 (UPDATE)
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
RegisterXblSessions(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, *RegisterXblSessionsBadRequest, error)
RegisterXblSessionsShort(params *RegisterXblSessionsParams, authInfo runtime.ClientAuthInfoWriter) (*RegisterXblSessionsOK, error)
SetTransport(transport runtime.ClientTransport)
}
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new session platform API client.
type RegisterXblSessionsBadRequest ¶
type RegisterXblSessionsBadRequest struct {
Payload *platformclientmodels.ValidationErrorEntity
}
RegisterXblSessionsBadRequest handles this case with default header values.
<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20002</td><td>validation error</td></tr></table>
func NewRegisterXblSessionsBadRequest ¶
func NewRegisterXblSessionsBadRequest() *RegisterXblSessionsBadRequest
NewRegisterXblSessionsBadRequest creates a RegisterXblSessionsBadRequest with default headers values
func (*RegisterXblSessionsBadRequest) Error ¶
func (o *RegisterXblSessionsBadRequest) Error() string
func (*RegisterXblSessionsBadRequest) GetPayload ¶
func (o *RegisterXblSessionsBadRequest) GetPayload() *platformclientmodels.ValidationErrorEntity
func (*RegisterXblSessionsBadRequest) ToJSONString ¶
func (o *RegisterXblSessionsBadRequest) ToJSONString() string
type RegisterXblSessionsOK ¶
type RegisterXblSessionsOK struct {
Payload map[string]interface{}
}
RegisterXblSessionsOK handles this case with default header values.
OK
func NewRegisterXblSessionsOK ¶
func NewRegisterXblSessionsOK() *RegisterXblSessionsOK
NewRegisterXblSessionsOK creates a RegisterXblSessionsOK with default headers values
func (*RegisterXblSessionsOK) Error ¶
func (o *RegisterXblSessionsOK) Error() string
func (*RegisterXblSessionsOK) GetPayload ¶
func (o *RegisterXblSessionsOK) GetPayload() map[string]interface{}
func (*RegisterXblSessionsOK) ToJSONString ¶
func (o *RegisterXblSessionsOK) ToJSONString() string
type RegisterXblSessionsParams ¶
type RegisterXblSessionsParams struct {
/*RetryPolicy*/
RetryPolicy *utils.Retry
/*Body*/
Body *platformclientmodels.XblUserSessionRequest
/*Namespace*/
Namespace string
/*UserID*/
UserID 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
}
RegisterXblSessionsParams contains all the parameters to send to the API endpoint for the register xbl sessions operation typically these are written to a http.Request
func NewRegisterXblSessionsParams ¶
func NewRegisterXblSessionsParams() *RegisterXblSessionsParams
NewRegisterXblSessionsParams creates a new RegisterXblSessionsParams object with the default values initialized.
func NewRegisterXblSessionsParamsWithContext ¶
func NewRegisterXblSessionsParamsWithContext(ctx context.Context) *RegisterXblSessionsParams
NewRegisterXblSessionsParamsWithContext creates a new RegisterXblSessionsParams object with the default values initialized, and the ability to set a context for a request
func NewRegisterXblSessionsParamsWithHTTPClient ¶
func NewRegisterXblSessionsParamsWithHTTPClient(client *http.Client) *RegisterXblSessionsParams
NewRegisterXblSessionsParamsWithHTTPClient creates a new RegisterXblSessionsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewRegisterXblSessionsParamsWithTimeout ¶
func NewRegisterXblSessionsParamsWithTimeout(timeout time.Duration) *RegisterXblSessionsParams
NewRegisterXblSessionsParamsWithTimeout creates a new RegisterXblSessionsParams object with the default values initialized, and the ability to set a timeout on a request
func (*RegisterXblSessionsParams) SetAuthInfoWriter ¶
func (o *RegisterXblSessionsParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the register xbl sessions params
func (*RegisterXblSessionsParams) SetBody ¶
func (o *RegisterXblSessionsParams) SetBody(body *platformclientmodels.XblUserSessionRequest)
SetBody adds the body to the register xbl sessions params
func (*RegisterXblSessionsParams) SetContext ¶
func (o *RegisterXblSessionsParams) SetContext(ctx context.Context)
SetContext adds the context to the register xbl sessions params
func (*RegisterXblSessionsParams) SetFlightId ¶ added in v0.63.0
func (o *RegisterXblSessionsParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*RegisterXblSessionsParams) SetHTTPClient ¶
func (o *RegisterXblSessionsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the register xbl sessions params
func (*RegisterXblSessionsParams) SetHTTPClientTransport ¶
func (o *RegisterXblSessionsParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the register xbl sessions params
func (*RegisterXblSessionsParams) SetNamespace ¶
func (o *RegisterXblSessionsParams) SetNamespace(namespace string)
SetNamespace adds the namespace to the register xbl sessions params
func (*RegisterXblSessionsParams) SetTimeout ¶
func (o *RegisterXblSessionsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the register xbl sessions params
func (*RegisterXblSessionsParams) SetUserID ¶
func (o *RegisterXblSessionsParams) SetUserID(userID string)
SetUserID adds the userId to the register xbl sessions params
func (*RegisterXblSessionsParams) WithBody ¶
func (o *RegisterXblSessionsParams) WithBody(body *platformclientmodels.XblUserSessionRequest) *RegisterXblSessionsParams
WithBody adds the body to the register xbl sessions params
func (*RegisterXblSessionsParams) WithContext ¶
func (o *RegisterXblSessionsParams) WithContext(ctx context.Context) *RegisterXblSessionsParams
WithContext adds the context to the register xbl sessions params
func (*RegisterXblSessionsParams) WithHTTPClient ¶
func (o *RegisterXblSessionsParams) WithHTTPClient(client *http.Client) *RegisterXblSessionsParams
WithHTTPClient adds the HTTPClient to the register xbl sessions params
func (*RegisterXblSessionsParams) WithNamespace ¶
func (o *RegisterXblSessionsParams) WithNamespace(namespace string) *RegisterXblSessionsParams
WithNamespace adds the namespace to the register xbl sessions params
func (*RegisterXblSessionsParams) WithTimeout ¶
func (o *RegisterXblSessionsParams) WithTimeout(timeout time.Duration) *RegisterXblSessionsParams
WithTimeout adds the timeout to the register xbl sessions params
func (*RegisterXblSessionsParams) WithUserID ¶
func (o *RegisterXblSessionsParams) WithUserID(userID string) *RegisterXblSessionsParams
WithUserID adds the userID to the register xbl sessions params
func (*RegisterXblSessionsParams) WriteToRequest ¶
func (o *RegisterXblSessionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type RegisterXblSessionsReader ¶
type RegisterXblSessionsReader struct {
// contains filtered or unexported fields
}
RegisterXblSessionsReader is a Reader for the RegisterXblSessions structure.
func (*RegisterXblSessionsReader) ReadResponse ¶
func (o *RegisterXblSessionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files