forge-dashboard-sdk-php

SharingApi
in package

SharingApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  : array<string|int, string> = ['getSharing' => ['application/json'], 'shareWi...

Properties

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int

Methods

__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getSharing()  : SharingResponse|Error
Operation getSharing
getSharingAsync()  : PromiseInterface
Operation getSharingAsync
getSharingAsyncWithHttpInfo()  : PromiseInterface
Operation getSharingAsyncWithHttpInfo
getSharingRequest()  : Request
Create request for operation 'getSharing'
getSharingWithHttpInfo()  : array<string|int, mixed>
Operation getSharingWithHttpInfo
setHostIndex()  : void
Set the host index
shareWith()  : void
Operation shareWith
shareWithAsync()  : PromiseInterface
Operation shareWithAsync
shareWithAsyncWithHttpInfo()  : PromiseInterface
Operation shareWithAsyncWithHttpInfo
shareWithRequest()  : Request
Create request for operation 'shareWith'
shareWithWithHttpInfo()  : array<string|int, mixed>
Operation shareWithWithHttpInfo
unshareWith()  : void
Operation unshareWith
unshareWithAsync()  : PromiseInterface
Operation unshareWithAsync
unshareWithAsyncWithHttpInfo()  : PromiseInterface
Operation unshareWithAsyncWithHttpInfo
unshareWithRequest()  : Request
Create request for operation 'unshareWith'
unshareWithWithHttpInfo()  : array<string|int, mixed>
Operation unshareWithWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string|int, string> contentTypes = ['getSharing' => ['application/json'], 'shareWith' => ['application/json'], 'unshareWith' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

getSharing()

Operation getSharing

public getSharing([string $contentType = self::contentTypes['getSharing'][0] ]) : SharingResponse|Error

The signed-in user's sharing relationships

Parameters
$contentType : string = self::contentTypes['getSharing'][0]

The value for the Content-Type header. Check self::contentTypes['getSharing'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
SharingResponse|Error

getSharingAsync()

Operation getSharingAsync

public getSharingAsync([string $contentType = self::contentTypes['getSharing'][0] ]) : PromiseInterface

The signed-in user's sharing relationships

Parameters
$contentType : string = self::contentTypes['getSharing'][0]

The value for the Content-Type header. Check self::contentTypes['getSharing'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharingAsyncWithHttpInfo()

Operation getSharingAsyncWithHttpInfo

public getSharingAsyncWithHttpInfo([string $contentType = self::contentTypes['getSharing'][0] ]) : PromiseInterface

The signed-in user's sharing relationships

Parameters
$contentType : string = self::contentTypes['getSharing'][0]

The value for the Content-Type header. Check self::contentTypes['getSharing'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharingRequest()

Create request for operation 'getSharing'

public getSharingRequest([string $contentType = self::contentTypes['getSharing'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getSharing'][0]

The value for the Content-Type header. Check self::contentTypes['getSharing'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSharingWithHttpInfo()

Operation getSharingWithHttpInfo

public getSharingWithHttpInfo([string $contentType = self::contentTypes['getSharing'][0] ]) : array<string|int, mixed>

The signed-in user's sharing relationships

Parameters
$contentType : string = self::contentTypes['getSharing'][0]

The value for the Content-Type header. Check self::contentTypes['getSharing'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\SharingResponse|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

shareWith()

Operation shareWith

public shareWith(string $username[, string $contentType = self::contentTypes['shareWith'][0] ]) : void

Share the signed-in user's dashboard with username

Parameters
$username : string

username (required)

$contentType : string = self::contentTypes['shareWith'][0]

The value for the Content-Type header. Check self::contentTypes['shareWith'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException

shareWithAsync()

Operation shareWithAsync

public shareWithAsync(string $username[, string $contentType = self::contentTypes['shareWith'][0] ]) : PromiseInterface

Share the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['shareWith'][0]

The value for the Content-Type header. Check self::contentTypes['shareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

shareWithAsyncWithHttpInfo()

Operation shareWithAsyncWithHttpInfo

public shareWithAsyncWithHttpInfo(string $username[, string $contentType = self::contentTypes['shareWith'][0] ]) : PromiseInterface

Share the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['shareWith'][0]

The value for the Content-Type header. Check self::contentTypes['shareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

shareWithRequest()

Create request for operation 'shareWith'

public shareWithRequest(string $username[, string $contentType = self::contentTypes['shareWith'][0] ]) : Request
Parameters
$username : string

(required)

$contentType : string = self::contentTypes['shareWith'][0]

The value for the Content-Type header. Check self::contentTypes['shareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

shareWithWithHttpInfo()

Operation shareWithWithHttpInfo

public shareWithWithHttpInfo(string $username[, string $contentType = self::contentTypes['shareWith'][0] ]) : array<string|int, mixed>

Share the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['shareWith'][0]

The value for the Content-Type header. Check self::contentTypes['shareWith'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

unshareWith()

Operation unshareWith

public unshareWith(string $username[, string $contentType = self::contentTypes['unshareWith'][0] ]) : void

Stop sharing the signed-in user's dashboard with username

Parameters
$username : string

username (required)

$contentType : string = self::contentTypes['unshareWith'][0]

The value for the Content-Type header. Check self::contentTypes['unshareWith'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException

unshareWithAsync()

Operation unshareWithAsync

public unshareWithAsync(string $username[, string $contentType = self::contentTypes['unshareWith'][0] ]) : PromiseInterface

Stop sharing the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['unshareWith'][0]

The value for the Content-Type header. Check self::contentTypes['unshareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

unshareWithAsyncWithHttpInfo()

Operation unshareWithAsyncWithHttpInfo

public unshareWithAsyncWithHttpInfo(string $username[, string $contentType = self::contentTypes['unshareWith'][0] ]) : PromiseInterface

Stop sharing the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['unshareWith'][0]

The value for the Content-Type header. Check self::contentTypes['unshareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

unshareWithRequest()

Create request for operation 'unshareWith'

public unshareWithRequest(string $username[, string $contentType = self::contentTypes['unshareWith'][0] ]) : Request
Parameters
$username : string

(required)

$contentType : string = self::contentTypes['unshareWith'][0]

The value for the Content-Type header. Check self::contentTypes['unshareWith'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

unshareWithWithHttpInfo()

Operation unshareWithWithHttpInfo

public unshareWithWithHttpInfo(string $username[, string $contentType = self::contentTypes['unshareWith'][0] ]) : array<string|int, mixed>

Stop sharing the signed-in user's dashboard with username

Parameters
$username : string

(required)

$contentType : string = self::contentTypes['unshareWith'][0]

The value for the Content-Type header. Check self::contentTypes['unshareWith'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

handleResponseWithDataType()

private handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
$dataType : string
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

responseWithinRangeCode()

private responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
$rangeCode : string
$statusCode : int
Return values
bool
On this page

Search results