modulepackage
4.2.1+incompatible
Repository: https://github.com/ardentblue/go-pubnub.git
Documentation: pkg.go.dev
# README
PubNub 4.2.1 client for Go
- Go (1.9+)
Please direct all Support Questions and Concerns to [email protected]
All new PubNub Go SDK
DOCS
Please direct all Support Questions and Concerns to [email protected]
# Functions
NewConfig initiates the config with default values.
NewDemoConfig initiates the config with demo keys, for tests only.
NewHTTP1Client creates a new HTTP 1 client with a new transport initialized with connect and read timeout.
NewHTTP2Client creates a new HTTP 2 client with a new transport initialized with connect and read timeout.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
MaxSequence for publish messages.
PNAccessDeniedCategory as the StatusCategory means that PAM is enabled and the channel is not granted R/W access.
PNAccessManagerGrant is the enum used for the Access Manager Grant operation.
PNAccessManagerRevoke is the enum used for the Access Manager Revoke operation.
PNAcknowledgmentCategory as the StatusCategory is the Acknowledgement of an operation (like Unsubscribe).
PNAddChannelsToChannelGroupOperation is the enum used for the Add Channels to Channel Group operation.
PNAddPushNotificationsOnChannelsOperation is the enum used for the Add Channels to Push Notifications operation.
PNBadRequestCategory as the StatusCategory means the request was malformed.
PNCancelledCategory as the StatusCategory means the context was cancelled.
PNChannelsForGroupOperation is the enum used for the List Channels of Channel Group operation.
PNConnectedCategory as the StatusCategory means the channel is subscribed to receive messages.
PNDeleteEnabled Delete Enabled.
PNDeleteMessagesOperation is the enum used for the Delete Messages from History operation.
PNDisconnectedCategory as the StatusCategory means a disconnection occurred due to network issues.
PNExponentialPolicy is to be used when selecting the Exponential Reconnection Policy ReconnectionPolicy is set in the config.
PNFetchMessagesOperation is the enum used for the Fetch operation.
PNFireOperation is the enum used for the Fire operation.
PNGetStateOperation is the enum used for the Get State operation.
PNHeartBeatOperation is the enum used for the Heartbeat operation.
PNHereNowOperation is the enum used for the Here Now operation.
PNHistoryOperation is the enum used for the History operation.
PNLinearPolicy is to be used when selecting the Linear Reconnection Policy ReconnectionPolicy is set in the config.
PNLoopStopCategory as the StatusCategory means the subscribe loop was stopped.
PNManageEnabled Manage Enabled.
PNMessageCountsOperation is the enum used for History with messages operation.
PNNonePolicy is to be used when selecting the no Reconnection Policy ReconnectionPolicy is set in the config.
PNNoStubMatchedCategory as the StatusCategory means an unknown status category event occurred.
PNPublishOperation is the enum used for the Publish operation.
PNPushNotificationsEnabledChannelsOperation is the enum used for the List Channels with Push Notifications enabled operation.
PNPushTypeAPNS is used as an enum to for selecting `APNS` as the PNPushType.
PNPushTypeGCM is used as an enum to for selecting `GCM` as the PNPushType.
PNPushTypeMPNS is used as an enum to for selecting `MPNS` as the PNPushType.
PNPushTypeNone is used as an enum to for selecting `none` as the PNPushType.
PNReadEnabled Read Enabled.
PNReconnectedCategory as the StatusCategory means that the network was reconnected (after a disconnection).
PNReconnectionAttemptsExhausted as the StatusCategory means that the reconnection attempts to reconnect to the network were exhausted.
PNRemoveAllPushNotificationsOperation is the enum used for the Remove All Channels from Push Notifications operation.
PNRemoveChannelFromChannelGroupOperation is the enum used for the Remove Channels from Channel Group operation.
PNRemoveGroupOperation is the enum used for the Remove Channel Group operation.
PNRemovePushNotificationsFromChannelsOperation is the enum used for the Remove Channels from Push Notifications operation.
PNRequestMessageCountExceededCategory is fired when the MessageQueueOverflowCount limit is exceeded by the number of messages received in a single subscribe request.
PNSetStateOperation is the enum used for the Set State operation.
PNSubscribeOperation is the enum used for the Subcribe operation.
PNTimeOperation is the enum used for the Time operation.
PNTimeoutCategory as the StatusCategory means the request timeout has reached.
PNUnknownCategory as the StatusCategory means an unknown status category event occurred.
PNUnsubscribeOperation is the enum used for the Unsubcribe operation.
PNWhereNowOperation is the enum used for the Where Now operation.
PNWriteEnabled Write Enabled.
StrChannelsTimetoken shows Missing Channels Timetoken message.
StrChannelsTimetokenLength shows Length of Channels Timetoken message.
StrMissingChannel shows Channel message.
StrMissingChannelGroup shows Channel Group message.
StrMissingDeviceID shows Missing Device ID message.
StrMissingMessage shows Missing Message message.
StrMissingPubKey shows Missing Publish Key message.
StrMissingPushType shows Missing Push Type message.
StrMissingSecretKey shows Missing Secret Key message.
StrMissingSubKey shows Missing Subscribe Key message.
StrMissingUUID shows Missing UUID message.
Version :the version of the SDK.
# Structs
AddChannelToChannelGroupResponse is the struct returned when the Execute function of AddChannelToChannelGroup is called.
AddPushNotificationsOnChannelsResponse is response structure for AddPushNotificationsOnChannelsBuilder.
AllChannelGroupResponse is the struct returned when the Execute function of List All Channel Groups is called.
Config instance is storage for user-provided information which describe further PubNub client behaviour.
DeleteChannelGroupResponse is response structure for Delete Channel Group function.
FetchResponse is the response to Fetch request.
FetchResponseItem contains the message and the associated timetoken.
GetStateResponse is the struct returned when the Execute function of GetState is called.
GrantResponse is the struct returned when the Execute function of Grant is called.
HeartbeatManager is a struct that assists in running of the heartbeat.
HereNowChannelData is the struct containing the occupancy details of the channels.
HereNowOccupantsData is the struct containing the state and UUID of the occupants in the channel.
HereNowResponse is the struct returned when the Execute function of HereNow is called.
HistoryDeleteResponse is the struct returned when Delete Messages is called.
HistoryResponse is used to store the response from the History request.
HistoryResponseItem is used to store the Message and the associated timetoken from the History request.
No description provided by the author
No description provided by the author
LatencyEntry is the struct to store the timestamp and latency values.
.
No description provided by the author
ListPushProvisionsRequestResponse is the struct returned when the Execute function of ListPushProvisions is called.
MessageCountsResponse is the response to MessageCounts request.
Operations is the struct to store the latency values of different operations.
PNAccessManagerKeyData is the struct containing the access details of the channel groups.
No description provided by the author
PNPAMEntityData is the struct containing the access details of the channels.
No description provided by the author
.
PublishResponse is the response after the execution on Publish and Fire operations.
PubNub No server connection will be established when you create a new PubNub object.
ReconnectionManager is used to store the properties required in running the Reconnection Manager.
RemoveAllPushChannelsForDeviceResponse is the struct returned when the Execute function of RemoveAllPushNotifications is called.
RemoveChannelFromChannelGroupResponse is the struct returned when the Execute function of RemoveChannelFromChannelGroup is called.
RemoveChannelsFromPushResponse is the struct returned when the Execute function of RemovePushNotificationsFromChannels is called.
No description provided by the author
ResponseInfo is used to store the properties in the response of an request.
SetStateResponse is the response returned when the Execute function of SetState is called.
StateManager is used to store the subscriptions types.
No description provided by the author
StatusResponse is used to store the usable properties in the response of an request.
SubscribeOperation.
SubscriptionItem is used to store the subscription item's properties.
Heartbeat: - Heartbeat is enabled by default.
TelemetryManager is the struct to store the Telemetry details.
TimeResponse is the response when Time call is executed.
No description provided by the author
WhereNowResponse is the response of the WhereNow request.
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
OperationType is used as an enum to catgorize the various operations in the APIs lifecycle.
PNGrantType grant types.
PNPushType is used as an enum to catgorize the available Push Types.
ReconnectionPolicy is used as an enum to catgorize the reconnection policies.
StatusCategory is used as an enum to catgorize the various status events in the APIs lifecycle.