forge-dashboard-sdk-php

SettingsApi
in package

ForgeDashboard

Generated

SettingsApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
getConfig() : Configuration
getFilterState() : array<string, mixed>|Error: Operation getFilterState
getFilterStateAsync() : PromiseInterface: Operation getFilterStateAsync
getFilterStateAsyncWithHttpInfo() : PromiseInterface: Operation getFilterStateAsyncWithHttpInfo
getFilterStateRequest() : Request: Create request for operation 'getFilterState'
getFilterStateWithHttpInfo() : array<string|int, mixed>: Operation getFilterStateWithHttpInfo
getHostIndex() : int: Get the host index
getSettings() : SettingsResponse|Error: Operation getSettings
getSettingsAsync() : PromiseInterface: Operation getSettingsAsync
getSettingsAsyncWithHttpInfo() : PromiseInterface: Operation getSettingsAsyncWithHttpInfo
getSettingsRequest() : Request: Create request for operation 'getSettings'
getSettingsWithHttpInfo() : array<string|int, mixed>: Operation getSettingsWithHttpInfo
getTheme() : ThemeResponse|Error: Operation getTheme
getThemeAsync() : PromiseInterface: Operation getThemeAsync
getThemeAsyncWithHttpInfo() : PromiseInterface: Operation getThemeAsyncWithHttpInfo
getThemeRequest() : Request: Create request for operation 'getTheme'
getThemeWithHttpInfo() : array<string|int, mixed>: Operation getThemeWithHttpInfo
getTimezone() : TimezoneResponse|Error: Operation getTimezone
getTimezoneAsync() : PromiseInterface: Operation getTimezoneAsync
getTimezoneAsyncWithHttpInfo() : PromiseInterface: Operation getTimezoneAsyncWithHttpInfo
getTimezoneRequest() : Request: Create request for operation 'getTimezone'
getTimezoneWithHttpInfo() : array<string|int, mixed>: Operation getTimezoneWithHttpInfo
putSettings() : SettingsResponse|Error: Operation putSettings
putSettingsAsync() : PromiseInterface: Operation putSettingsAsync
putSettingsAsyncWithHttpInfo() : PromiseInterface: Operation putSettingsAsyncWithHttpInfo
putSettingsRequest() : Request: Create request for operation 'putSettings'
putSettingsWithHttpInfo() : array<string|int, mixed>: Operation putSettingsWithHttpInfo
setFilterState() : void: Operation setFilterState
setFilterStateAsync() : PromiseInterface: Operation setFilterStateAsync
setFilterStateAsyncWithHttpInfo() : PromiseInterface: Operation setFilterStateAsyncWithHttpInfo
setFilterStateRequest() : Request: Create request for operation 'setFilterState'
setFilterStateWithHttpInfo() : array<string|int, mixed>: Operation setFilterStateWithHttpInfo
setHostIndex() : void: Set the host index
setTheme() : ThemeResponse|Error: Operation setTheme
setThemeAsync() : PromiseInterface: Operation setThemeAsync
setThemeAsyncWithHttpInfo() : PromiseInterface: Operation setThemeAsyncWithHttpInfo
setThemeRequest() : Request: Create request for operation 'setTheme'
setThemeWithHttpInfo() : array<string|int, mixed>: Operation setThemeWithHttpInfo
setTimezone() : TimezoneResponse|Error: Operation setTimezone
setTimezoneAsync() : PromiseInterface: Operation setTimezoneAsync
setTimezoneAsyncWithHttpInfo() : PromiseInterface: Operation setTimezoneAsyncWithHttpInfo
setTimezoneRequest() : Request: Create request for operation 'setTimezone'
setTimezoneWithHttpInfo() : array<string|int, mixed>: Operation setTimezoneWithHttpInfo
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['getFilterState' => ['application/json'], 'getSettings' => ['application/json'], 'getTheme' => ['application/json'], 'getTimezone' => ['application/json'], 'putSettings' => ['application/json'], 'setFilterState' => ['application/json'], 'setTheme' => ['application/json'], 'setTimezone' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__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

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getFilterState()

Operation getFilterState


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

The signed-in user's own saved dashboard/Insights filter state

Parameters

$contentType : string = self::contentTypes['getFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['getFilterState'] to see the possible values for this operation

Return values

array<string, mixed>|Error

getFilterStateAsync()

Operation getFilterStateAsync


    public
                    getFilterStateAsync([string $contentType = self::contentTypes['getFilterState'][0] ]) : PromiseInterface

The signed-in user's own saved dashboard/Insights filter state

Parameters

$contentType : string = self::contentTypes['getFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['getFilterState'] to see the possible values for this operation

Return values

PromiseInterface

getFilterStateAsyncWithHttpInfo()

Operation getFilterStateAsyncWithHttpInfo


    public
                    getFilterStateAsyncWithHttpInfo([string $contentType = self::contentTypes['getFilterState'][0] ]) : PromiseInterface

The signed-in user's own saved dashboard/Insights filter state

Parameters

$contentType : string = self::contentTypes['getFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['getFilterState'] to see the possible values for this operation

Return values

PromiseInterface

getFilterStateRequest()

Create request for operation 'getFilterState'


    public
                    getFilterStateRequest([string $contentType = self::contentTypes['getFilterState'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['getFilterState'] to see the possible values for this operation

Return values

Request

getFilterStateWithHttpInfo()

Operation getFilterStateWithHttpInfo


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

The signed-in user's own saved dashboard/Insights filter state

Parameters

$contentType : string = self::contentTypes['getFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['getFilterState'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of array<string,mixed>|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getSettings()

Operation getSettings


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

The signed-in user's own forge configuration

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

SettingsResponse|Error

getSettingsAsync()

Operation getSettingsAsync


    public
                    getSettingsAsync([string $contentType = self::contentTypes['getSettings'][0] ]) : PromiseInterface

The signed-in user's own forge configuration

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

PromiseInterface

getSettingsAsyncWithHttpInfo()

Operation getSettingsAsyncWithHttpInfo


    public
                    getSettingsAsyncWithHttpInfo([string $contentType = self::contentTypes['getSettings'][0] ]) : PromiseInterface

The signed-in user's own forge configuration

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

PromiseInterface

getSettingsRequest()

Create request for operation 'getSettings'


    public
                    getSettingsRequest([string $contentType = self::contentTypes['getSettings'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

Request

getSettingsWithHttpInfo()

Operation getSettingsWithHttpInfo


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

The signed-in user's own forge configuration

Parameters

$contentType : string = self::contentTypes['getSettings'][0]: The value for the Content-Type header. Check self::contentTypes['getSettings'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getTheme()

Operation getTheme


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

The signed-in user's own saved theme preference

Parameters

$contentType : string = self::contentTypes['getTheme'][0]: The value for the Content-Type header. Check self::contentTypes['getTheme'] to see the possible values for this operation

Return values

ThemeResponse|Error

getThemeAsync()

Operation getThemeAsync


    public
                    getThemeAsync([string $contentType = self::contentTypes['getTheme'][0] ]) : PromiseInterface

The signed-in user's own saved theme preference

Parameters

$contentType : string = self::contentTypes['getTheme'][0]: The value for the Content-Type header. Check self::contentTypes['getTheme'] to see the possible values for this operation

Return values

PromiseInterface

getThemeAsyncWithHttpInfo()

Operation getThemeAsyncWithHttpInfo


    public
                    getThemeAsyncWithHttpInfo([string $contentType = self::contentTypes['getTheme'][0] ]) : PromiseInterface

The signed-in user's own saved theme preference

Parameters

$contentType : string = self::contentTypes['getTheme'][0]: The value for the Content-Type header. Check self::contentTypes['getTheme'] to see the possible values for this operation

Return values

PromiseInterface

getThemeRequest()

Create request for operation 'getTheme'


    public
                    getThemeRequest([string $contentType = self::contentTypes['getTheme'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getTheme'][0]: The value for the Content-Type header. Check self::contentTypes['getTheme'] to see the possible values for this operation

Return values

Request

getThemeWithHttpInfo()

Operation getThemeWithHttpInfo


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

The signed-in user's own saved theme preference

Parameters

$contentType : string = self::contentTypes['getTheme'][0]: The value for the Content-Type header. Check self::contentTypes['getTheme'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

getTimezone()

Operation getTimezone


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

The signed-in user's own saved time zone

Parameters

$contentType : string = self::contentTypes['getTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['getTimezone'] to see the possible values for this operation

Return values

TimezoneResponse|Error

getTimezoneAsync()

Operation getTimezoneAsync


    public
                    getTimezoneAsync([string $contentType = self::contentTypes['getTimezone'][0] ]) : PromiseInterface

The signed-in user's own saved time zone

Parameters

$contentType : string = self::contentTypes['getTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['getTimezone'] to see the possible values for this operation

Return values

PromiseInterface

getTimezoneAsyncWithHttpInfo()

Operation getTimezoneAsyncWithHttpInfo


    public
                    getTimezoneAsyncWithHttpInfo([string $contentType = self::contentTypes['getTimezone'][0] ]) : PromiseInterface

The signed-in user's own saved time zone

Parameters

$contentType : string = self::contentTypes['getTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['getTimezone'] to see the possible values for this operation

Return values

PromiseInterface

getTimezoneRequest()

Create request for operation 'getTimezone'


    public
                    getTimezoneRequest([string $contentType = self::contentTypes['getTimezone'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['getTimezone'] to see the possible values for this operation

Return values

Request

getTimezoneWithHttpInfo()

Operation getTimezoneWithHttpInfo


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

The signed-in user's own saved time zone

Parameters

$contentType : string = self::contentTypes['getTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['getTimezone'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

putSettings()

Operation putSettings


    public
                    putSettings(SettingsRequest $settings_request[, string $contentType = self::contentTypes['putSettings'][0] ]) : SettingsResponse|Error

Save the signed-in user's forge configuration

Parameters

$settings_request : SettingsRequest: settings_request (required)
$contentType : string = self::contentTypes['putSettings'][0]: The value for the Content-Type header. Check self::contentTypes['putSettings'] to see the possible values for this operation

Return values

SettingsResponse|Error

putSettingsAsync()

Operation putSettingsAsync


    public
                    putSettingsAsync(SettingsRequest $settings_request[, string $contentType = self::contentTypes['putSettings'][0] ]) : PromiseInterface

Save the signed-in user's forge configuration

Parameters

$settings_request : SettingsRequest: (required)
$contentType : string = self::contentTypes['putSettings'][0]: The value for the Content-Type header. Check self::contentTypes['putSettings'] to see the possible values for this operation

Return values

PromiseInterface

putSettingsAsyncWithHttpInfo()

Operation putSettingsAsyncWithHttpInfo


    public
                    putSettingsAsyncWithHttpInfo(SettingsRequest $settings_request[, string $contentType = self::contentTypes['putSettings'][0] ]) : PromiseInterface

Save the signed-in user's forge configuration

Parameters

$settings_request : SettingsRequest: (required)
$contentType : string = self::contentTypes['putSettings'][0]: The value for the Content-Type header. Check self::contentTypes['putSettings'] to see the possible values for this operation

Return values

PromiseInterface

putSettingsRequest()

Create request for operation 'putSettings'


    public
                    putSettingsRequest(SettingsRequest $settings_request[, string $contentType = self::contentTypes['putSettings'][0] ]) : Request

Parameters

$settings_request : SettingsRequest: (required)
$contentType : string = self::contentTypes['putSettings'][0]: The value for the Content-Type header. Check self::contentTypes['putSettings'] to see the possible values for this operation

Return values

Request

putSettingsWithHttpInfo()

Operation putSettingsWithHttpInfo


    public
                    putSettingsWithHttpInfo(SettingsRequest $settings_request[, string $contentType = self::contentTypes['putSettings'][0] ]) : array<string|int, mixed>

Save the signed-in user's forge configuration

Parameters

$settings_request : SettingsRequest: (required)
$contentType : string = self::contentTypes['putSettings'][0]: The value for the Content-Type header. Check self::contentTypes['putSettings'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

setFilterState()

Operation setFilterState


    public
                    setFilterState(array<string, mixed> $request_body[, string $contentType = self::contentTypes['setFilterState'][0] ]) : void

Save the signed-in user's own dashboard/Insights filter state

Parameters

$request_body : array<string, mixed>: request_body (required)
$contentType : string = self::contentTypes['setFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['setFilterState'] to see the possible values for this operation

setFilterStateAsync()

Operation setFilterStateAsync


    public
                    setFilterStateAsync(array<string, mixed> $request_body[, string $contentType = self::contentTypes['setFilterState'][0] ]) : PromiseInterface

Save the signed-in user's own dashboard/Insights filter state

Parameters

$request_body : array<string, mixed>: (required)
$contentType : string = self::contentTypes['setFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['setFilterState'] to see the possible values for this operation

Return values

PromiseInterface

setFilterStateAsyncWithHttpInfo()

Operation setFilterStateAsyncWithHttpInfo


    public
                    setFilterStateAsyncWithHttpInfo(array<string, mixed> $request_body[, string $contentType = self::contentTypes['setFilterState'][0] ]) : PromiseInterface

Save the signed-in user's own dashboard/Insights filter state

Parameters

$request_body : array<string, mixed>: (required)
$contentType : string = self::contentTypes['setFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['setFilterState'] to see the possible values for this operation

Return values

PromiseInterface

setFilterStateRequest()

Create request for operation 'setFilterState'


    public
                    setFilterStateRequest(array<string, mixed> $request_body[, string $contentType = self::contentTypes['setFilterState'][0] ]) : Request

Parameters

$request_body : array<string, mixed>: (required)
$contentType : string = self::contentTypes['setFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['setFilterState'] to see the possible values for this operation

Return values

Request

setFilterStateWithHttpInfo()

Operation setFilterStateWithHttpInfo


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

Save the signed-in user's own dashboard/Insights filter state

Parameters

$request_body : array<string, mixed>: (required)
$contentType : string = self::contentTypes['setFilterState'][0]: The value for the Content-Type header. Check self::contentTypes['setFilterState'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, 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)

setTheme()

Operation setTheme


    public
                    setTheme(ThemeRequest $theme_request[, string $contentType = self::contentTypes['setTheme'][0] ]) : ThemeResponse|Error

Save the signed-in user's own theme preference

Parameters

$theme_request : ThemeRequest: theme_request (required)
$contentType : string = self::contentTypes['setTheme'][0]: The value for the Content-Type header. Check self::contentTypes['setTheme'] to see the possible values for this operation

Return values

ThemeResponse|Error

setThemeAsync()

Operation setThemeAsync


    public
                    setThemeAsync(ThemeRequest $theme_request[, string $contentType = self::contentTypes['setTheme'][0] ]) : PromiseInterface

Save the signed-in user's own theme preference

Parameters

$theme_request : ThemeRequest: (required)
$contentType : string = self::contentTypes['setTheme'][0]: The value for the Content-Type header. Check self::contentTypes['setTheme'] to see the possible values for this operation

Return values

PromiseInterface

setThemeAsyncWithHttpInfo()

Operation setThemeAsyncWithHttpInfo


    public
                    setThemeAsyncWithHttpInfo(ThemeRequest $theme_request[, string $contentType = self::contentTypes['setTheme'][0] ]) : PromiseInterface

Save the signed-in user's own theme preference

Parameters

$theme_request : ThemeRequest: (required)
$contentType : string = self::contentTypes['setTheme'][0]: The value for the Content-Type header. Check self::contentTypes['setTheme'] to see the possible values for this operation

Return values

PromiseInterface

setThemeRequest()

Create request for operation 'setTheme'


    public
                    setThemeRequest(ThemeRequest $theme_request[, string $contentType = self::contentTypes['setTheme'][0] ]) : Request

Parameters

$theme_request : ThemeRequest: (required)
$contentType : string = self::contentTypes['setTheme'][0]: The value for the Content-Type header. Check self::contentTypes['setTheme'] to see the possible values for this operation

Return values

Request

setThemeWithHttpInfo()

Operation setThemeWithHttpInfo


    public
                    setThemeWithHttpInfo(ThemeRequest $theme_request[, string $contentType = self::contentTypes['setTheme'][0] ]) : array<string|int, mixed>

Save the signed-in user's own theme preference

Parameters

$theme_request : ThemeRequest: (required)
$contentType : string = self::contentTypes['setTheme'][0]: The value for the Content-Type header. Check self::contentTypes['setTheme'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

setTimezone()

Operation setTimezone


    public
                    setTimezone(TimezoneRequest $timezone_request[, string $contentType = self::contentTypes['setTimezone'][0] ]) : TimezoneResponse|Error

Save the signed-in user's own time zone

Parameters

$timezone_request : TimezoneRequest: timezone_request (required)
$contentType : string = self::contentTypes['setTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['setTimezone'] to see the possible values for this operation

Return values

TimezoneResponse|Error

setTimezoneAsync()

Operation setTimezoneAsync


    public
                    setTimezoneAsync(TimezoneRequest $timezone_request[, string $contentType = self::contentTypes['setTimezone'][0] ]) : PromiseInterface

Save the signed-in user's own time zone

Parameters

$timezone_request : TimezoneRequest: (required)
$contentType : string = self::contentTypes['setTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['setTimezone'] to see the possible values for this operation

Return values

PromiseInterface

setTimezoneAsyncWithHttpInfo()

Operation setTimezoneAsyncWithHttpInfo


    public
                    setTimezoneAsyncWithHttpInfo(TimezoneRequest $timezone_request[, string $contentType = self::contentTypes['setTimezone'][0] ]) : PromiseInterface

Save the signed-in user's own time zone

Parameters

$timezone_request : TimezoneRequest: (required)
$contentType : string = self::contentTypes['setTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['setTimezone'] to see the possible values for this operation

Return values

PromiseInterface

setTimezoneRequest()

Create request for operation 'setTimezone'


    public
                    setTimezoneRequest(TimezoneRequest $timezone_request[, string $contentType = self::contentTypes['setTimezone'][0] ]) : Request

Parameters

$timezone_request : TimezoneRequest: (required)
$contentType : string = self::contentTypes['setTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['setTimezone'] to see the possible values for this operation

Return values

Request

setTimezoneWithHttpInfo()

Operation setTimezoneWithHttpInfo


    public
                    setTimezoneWithHttpInfo(TimezoneRequest $timezone_request[, string $contentType = self::contentTypes['setTimezone'][0] ]) : array<string|int, mixed>

Save the signed-in user's own time zone

Parameters

$timezone_request : TimezoneRequest: (required)
$contentType : string = self::contentTypes['setTimezone'][0]: The value for the Content-Type header. Check self::contentTypes['setTimezone'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

createHttpClientOption()

Create http client option


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

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

SettingsApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

getConfig()

Return values

getFilterState()

Parameters

Tags

Return values

getFilterStateAsync()

Parameters

Tags

Return values

getFilterStateAsyncWithHttpInfo()

Parameters

Tags

Return values

getFilterStateRequest()

Parameters

Tags

Return values

getFilterStateWithHttpInfo()

Parameters

Tags

Return values

getHostIndex()

Return values

getSettings()

Parameters

Tags

Return values

getSettingsAsync()

Parameters

Tags

Return values

getSettingsAsyncWithHttpInfo()

Parameters

Tags

Return values

getSettingsRequest()

Parameters

Tags

Return values

getSettingsWithHttpInfo()

Parameters

Tags

Return values

getTheme()

Parameters

Tags

Return values

getThemeAsync()

Parameters

Tags

Return values

getThemeAsyncWithHttpInfo()

Parameters

Tags

Return values

getThemeRequest()

Parameters

Tags

Return values

getThemeWithHttpInfo()

Parameters

Tags

Return values

SettingsApi
in package

ForgeDashboard

Generated