Documentation

PubNub
in package
implements LoggerAwareInterface

Table of Contents

Interfaces

LoggerAwareInterface
Describes a logger-aware instance.

Constants

SDK_NAME  = "PubNub-PHP"
SDK_VERSION  = "6.3.0"

Properties

$MAX_SEQUENCE  : mixed
$basePathManager  : BasePathManager
$configuration  : PNConfiguration
$cryptoModule  : CryptoModule|null
$logger  : LoggerInterface
$nextSequence  : int
$subscriptionManager  : SubscriptionManager
$telemetryManager  : TelemetryManager
$tokenManager  : TokenManager

Methods

__construct()  : mixed
PNConfiguration constructor.
addChannelsToPush()  : AddChannelsToPush
addChannelToChannelGroup()  : AddChannelToChannelGroup
addListener()  : mixed
audit()  : Audit
deleteFile()  : mixed
deleteMessages()  : HistoryDelete
demo()  : static
Pre-configured PubNub client with demo-keys
downloadFile()  : mixed
fetchMessages()  : FetchMessages
fire()  : Fire
getAllChannelMetadata()  : GetAllChannelMetadata
getAllUUIDMetadata()  : GetAllUUIDMetadata
getBasePath()  : string
getChannelMetadata()  : GetChannelMetadata
getConfiguration()  : PNConfiguration
Get PubNub configuration object
getCrypto()  : CryptoModule|null
getCryptoSafe()  : CryptoModule|null
getFileDownloadUrl()  : mixed
getLogger()  : Logger
getMembers()  : GetMembers
getMemberships()  : GetMemberships
getSdkFullName()  : string
getSdkName()  : string
getSdkVersion()  : string
getSequenceId()  : int
getState()  : GetState
getTelemetryManager()  : TelemetryManager
getToken()  : string
getUUIDMetadata()  : GetUUIDMetadata
grant()  : Grant
grantToken()  : GrantToken
hereNow()  : HereNow
history()  : History
isCryptoEnabled()  : bool
listChannelsInChannelGroup()  : ListChannelsInChannelGroup
listFiles()  : mixed
listPushProvisions()  : ListPushProvisions
messageCounts()  : MessageCount
parseToken()  : PNAccessManagerTokenResult
publish()  : Publish
removeAllPushChannelsForDevice()  : RemoveDeviceFromPush
removeChannelFromChannelGroup()  : RemoveChannelFromChannelGroup
removeChannelGroup()  : RemoveChannelGroup
removeChannelMetadata()  : RemoveChannelMetadata
removeChannelsFromPush()  : RemoveChannelsFromPush
removeListener()  : mixed
removeMembers()  : RemoveMembers
removeMemberships()  : RemoveMemberships
removeUUIDMetadata()  : RemoveUUIDMetadata
revoke()  : Revoke
revokeToken()  : RevokeToken
sendFile()  : mixed
setChannelMetadata()  : SetChannelMetadata
setCrypto()  : mixed
setLogger()  : void
Sets a logger instance on the object.
setMembers()  : SetMembers
setMemberships()  : SetMemberships
setState()  : SetState
setToken()  : mixed
setUUIDMetadata()  : SetUUIDMetadata
signal()  : Signal
subscribe()  : SubscribeBuilder
time()  : Time
timestamp()  : int
whereNow()  : WhereNow
validateConfig()  : mixed

Constants

SDK_NAME

protected mixed SDK_NAME = "PubNub-PHP"

SDK_VERSION

protected mixed SDK_VERSION = "6.3.0"

Properties

$MAX_SEQUENCE

public static mixed $MAX_SEQUENCE = 65535

$nextSequence

protected int $nextSequence = 0

Methods

__construct()

PNConfiguration constructor.

public __construct(mixed $initialConfig) : mixed
Parameters
$initialConfig : mixed

PNConfiguration

deleteFile()

public deleteFile() : mixed

demo()

Pre-configured PubNub client with demo-keys

public static demo() : static
Return values
static

downloadFile()

public downloadFile() : mixed

getBasePath()

public getBasePath([mixed $customHost = null ]) : string
Parameters
$customHost : mixed = null
Return values
string

Base path

getFileDownloadUrl()

public getFileDownloadUrl() : mixed

getLogger()

public getLogger() : Logger
Return values
Logger

getSdkFullName()

public static getSdkFullName() : string
Return values
string

getSdkName()

public static getSdkName() : string
Return values
string

getSdkVersion()

public static getSdkVersion() : string
Return values
string

getSequenceId()

public getSequenceId() : int
Return values
int

unique sequence identifier

getToken()

public getToken() : string
Return values
string

Token previously set by $this->setToken

isCryptoEnabled()

public isCryptoEnabled() : bool
Return values
bool

listFiles()

public listFiles() : mixed

parseToken()

public parseToken(mixed $token) : PNAccessManagerTokenResult
Parameters
$token : mixed
Return values
PNAccessManagerTokenResult

sendFile()

public sendFile() : mixed

setToken()

public setToken(string $token) : mixed
Parameters
$token : string

Token obtained by GetToken

timestamp()

public timestamp() : int
Return values
int

        
On this page

Search results