PNStatus
in package
Table of Contents
Properties
- $affectedChannelGroups : null|array<string|int, mixed>
- $affectedChannels : null|array<string|int, mixed>
- $affectedUsers : null|array<string|int, mixed>
- $authKey : string
- $category : int
- $exception : PubNubException
- $operation : int
- $origin : string
- $originalResponse : Requests_Response
- $statusCode : int
- $tlsEnabled : bool
- $uuid : string
Methods
- getAffectedChannelGroups() : array<string|int, mixed>|null
- getAffectedChannels() : array<string|int, mixed>|null
- getAffectedUsers() : array<string|int, mixed>|null
- getAuthKey() : string
- getCategory() : int
- getException() : PubNubException
- getOperation() : int
- getOrigin() : string
- getOriginalResponse() : Requests_Response
- getStatusCode() : int
- getUuid() : string
- isError() : bool
- isTlsEnabled() : bool
- setAffectedChannelGroups() : $this
- setAffectedChannels() : $this
- setAffectedUsers() : $this
- setAuthKey() : $this
- setCategory() : $this
- setException() : $this
- setOperation() : $this
- setOrigin() : $this
- setOriginalResponse() : $this
- setStatusCode() : $this
- setTlsEnabled() : $this
- setUuid() : $this
Properties
$affectedChannelGroups
private
null|array<string|int, mixed>
$affectedChannelGroups
$affectedChannels
private
null|array<string|int, mixed>
$affectedChannels
$affectedUsers
private
null|array<string|int, mixed>
$affectedUsers
$authKey
private
string
$authKey
$category
private
int
$category
PNStatusCategory
$exception
private
PubNubException
$exception
$operation
private
int
$operation
PNOperationType
$origin
private
string
$origin
$originalResponse
private
Requests_Response
$originalResponse
$statusCode
private
int
$statusCode
$tlsEnabled
private
bool
$tlsEnabled
$uuid
private
string
$uuid
Methods
getAffectedChannelGroups()
public
getAffectedChannelGroups() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetAffectedChannels()
public
getAffectedChannels() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetAffectedUsers()
public
getAffectedUsers() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetAuthKey()
public
getAuthKey() : string
Return values
stringgetCategory()
public
getCategory() : int
Return values
int —PNStatusCategory
getException()
public
getException() : PubNubException
Return values
PubNubExceptiongetOperation()
public
getOperation() : int
Return values
int —PNOperationType
getOrigin()
public
getOrigin() : string
Return values
stringgetOriginalResponse()
public
getOriginalResponse() : Requests_Response
Return values
Requests_ResponsegetStatusCode()
public
getStatusCode() : int
Return values
intgetUuid()
public
getUuid() : string
Return values
stringisError()
public
isError() : bool
Return values
boolisTlsEnabled()
public
isTlsEnabled() : bool
Return values
boolsetAffectedChannelGroups()
public
setAffectedChannelGroups(array<string|int, mixed>|null $affectedChannelGroups) : $this
Parameters
- $affectedChannelGroups : array<string|int, mixed>|null
Return values
$thissetAffectedChannels()
public
setAffectedChannels(array<string|int, mixed>|null $affectedChannels) : $this
Parameters
- $affectedChannels : array<string|int, mixed>|null
Return values
$thissetAffectedUsers()
public
setAffectedUsers(array<string|int, mixed>|null $affectedUsers) : $this
Parameters
- $affectedUsers : array<string|int, mixed>|null
Return values
$thissetAuthKey()
public
setAuthKey(string $authKey) : $this
Parameters
- $authKey : string
Return values
$thissetCategory()
public
setCategory(int $category) : $this
Parameters
- $category : int
-
PNStatusCategory
Return values
$thissetException()
public
setException(PubNubException $exception) : $this
Parameters
- $exception : PubNubException
Return values
$thissetOperation()
public
setOperation(int $operation) : $this
Parameters
- $operation : int
-
PNOperationType
Return values
$thissetOrigin()
public
setOrigin(string $origin) : $this
Parameters
- $origin : string
Return values
$thissetOriginalResponse()
public
setOriginalResponse(Requests_Response $originalResponse) : $this
Parameters
- $originalResponse : Requests_Response
Return values
$thissetStatusCode()
public
setStatusCode(int $statusCode) : $this
Parameters
- $statusCode : int
Return values
$thissetTlsEnabled()
public
setTlsEnabled(bool $tlsEnabled) : $this
Parameters
- $tlsEnabled : bool
Return values
$thissetUuid()
public
setUuid(string $uuid) : $this
Parameters
- $uuid : string