Documentation

SetState extends Endpoint
in package

Table of Contents

Constants

PATH  = "/v2/presence/sub-key/%s/channel/%s/uuid/%s/data"
RESPONSE_IS_JSON  = true

Properties

$cachedTransports  : array<string|int, mixed>
$channels  : array<string|int, string>
$customHost  : mixed
$envelope  : PNEnvelope
$followRedirects  : mixed
$groups  : array<string|int, string>
$pubnub  : PubNub
$state  : array<string|int, mixed>

Methods

__construct()  : mixed
buildParams()  : array<string|int, mixed>
Params build flow: signed <- custom <- default
buildPath()  : string
channelGroups()  : $this
channels()  : $this
clear()  : mixed
Clear cached envelope
createResponse()  : PNSetStateResult|array<string|int, mixed>
envelope()  : PNEnvelope
Returns an Envelope that contains both result and status.
getAffectedChannelGroups()  : array<string|int, string>|string
getAffectedChannels()  : array<string|int, string>|string
getConnectTimeout()  : int
getRequestTimeout()  : int
state()  : $this
sync()  : PNSetStateResult
Return a Result only.
buildData()  : null
customHeaders()  : mixed
customParams()  : array<string|int, mixed>
defaultHeaders()  : mixed
defaultParams()  : array<string|int, mixed>
fetchPayload()  : array<string|int, mixed>
getAffectedUsers()  : mixed
getName()  : string
getOperationType()  : int
getTransport()  : mixed
httpMethod()  : string
invokeRequest()  : PNEnvelope
invokeRequestAndCacheIt()  : PNEnvelope
isAuthRequired()  : bool
requestOptions()  : array<string|int, mixed>
validateChannelGroups()  : mixed
validateParams()  : mixed
validatePublishKey()  : mixed
validateSecretKey()  : mixed
validateSubscribeKey()  : mixed
createStatus()  : PNStatus
getDefaultTransport()  : Transport

Constants

PATH

public mixed PATH = "/v2/presence/sub-key/%s/channel/%s/uuid/%s/data"

RESPONSE_IS_JSON

protected mixed RESPONSE_IS_JSON = true

Properties

$cachedTransports

protected static array<string|int, mixed> $cachedTransports = []

$channels

protected array<string|int, string> $channels = []

$customHost

protected mixed $customHost = null

$followRedirects

protected mixed $followRedirects = true

$groups

protected array<string|int, string> $groups = []

$state

protected array<string|int, mixed> $state = []

Methods

__construct()

public __construct(PubNub $pubnubInstance) : mixed
Parameters
$pubnubInstance : PubNub

buildParams()

Params build flow: signed <- custom <- default

public buildParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildPath()

public buildPath() : string
Return values
string

channelGroups()

public channelGroups(mixed $groups) : $this
Parameters
$groups : mixed
Return values
$this

channels()

public channels(string|array<string|int, string> $channels) : $this
Parameters
$channels : string|array<string|int, string>
Return values
$this

clear()

Clear cached envelope

public clear() : mixed

createResponse()

public createResponse(array<string|int, mixed> $result) : PNSetStateResult|array<string|int, mixed>
Parameters
$result : array<string|int, mixed>

Decoded json

Return values
PNSetStateResult|array<string|int, mixed>

envelope()

Returns an Envelope that contains both result and status.

public envelope() : PNEnvelope

All Errors are wrapped, so no need to use try/catch blocks

Return values
PNEnvelope

getAffectedChannelGroups()

public getAffectedChannelGroups() : array<string|int, string>|string
Return values
array<string|int, string>|string

getAffectedChannels()

public getAffectedChannels() : array<string|int, string>|string
Return values
array<string|int, string>|string

getConnectTimeout()

public getConnectTimeout() : int
Return values
int

getRequestTimeout()

public getRequestTimeout() : int
Return values
int

state()

public state(array<string|int, mixed> $state) : $this
Parameters
$state : array<string|int, mixed>
Return values
$this

buildData()

protected buildData() : null
Return values
null

customHeaders()

protected customHeaders() : mixed

customParams()

protected customParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

defaultHeaders()

protected defaultHeaders() : mixed

defaultParams()

protected defaultParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

fetchPayload()

protected static fetchPayload(mixed $json) : array<string|int, mixed>
Parameters
$json : mixed
Tags
throws
PubNubResponseParsingException
Return values
array<string|int, mixed>

getAffectedUsers()

protected getAffectedUsers() : mixed

getName()

protected getName() : string
Return values
string

getOperationType()

protected getOperationType() : int
Return values
int

getTransport()

protected getTransport() : mixed

httpMethod()

protected httpMethod() : string
Return values
string —

PNHttpMethod

isAuthRequired()

protected isAuthRequired() : bool
Return values
bool

requestOptions()

protected requestOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

validateChannelGroups()

protected validateChannelGroups(array<string|int, string>|string $channels, array<string|int, string>|string $groups) : mixed
Parameters
$channels : array<string|int, string>|string
$groups : array<string|int, string>|string
Tags
throws
PubNubValidationException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results