| Schema — OPTIONAL |
|---|
accessManager objectenabled booleanEnable or disable Access Manager | tokenRevoke booleanEnables token invalidation so it can't access to PubNub resources. Enabling this may introduce some latency in your API calls to check the validity of the token |
| files objectenabled booleanEnable or disable file sharing | retention numberPossible values: [1, 7, 30, 90, 180, 365, 0] Number of days to retain files. Valid values: 1, 7, 30, 90, 180, 365, or 0 for unlimited. Align file retention with your Message Persistence settings to keep messages and files for the same duration. | region stringPossible values: [us-east-1, us-west-1, eu-central-1, ap-south-1, ap-northeast-1] The geographical region where PubNub stores and manages your files. Once a region is set it cannot be changed. Valid values: us-east-1, us-west-1, eu-central-1, ap-south-1, ap-northeast-1. Align file retention with your Message Persistence settings to keep messages and files for the same duration. |
| streamController objectenabled booleanEnable or disable stream controller | wildcardSubscribe booleanAllows subscribing to wildcard channels (eg. foo.*) | channelGroupLimit between(1, 2000)Possible values: 1 ≤ value ≤ 2000 Channel group limit between 1 and 2000 for paid plans only, free plans have a limit of 100 |
| appContext objectenabled booleanEnable or disable app context | region stringPossible values: [aws-iad-1, aws-pdx-1, aws-fra-1, aws-bom-1, aws-hnd-1] The geographic region where your App Context data is stored and managed. Choose a region close to your users to reduce latency and improve performance. Once a region is set it cannot be changed. Valid values: aws-iad-1, aws-pdx-1, aws-fra-1, aws-bom-1, aws-hnd-1. | userMetadataEvents booleanEnable or disable user metadata events, which are triggered when user metadata is set or removed in the objects database. | channelMetadataEvents booleanEnable or disable channel metadata events, which are triggered when channel metadata is set or removed in the objects database. Apps can subscribe and update UI based on channel property changes. | membershipEvents booleanEnables or disables membership (associations between users and channels) events, which are triggered when memberships are added, updated or removed in the objects database. This helps you manage and respond to who belongs to which channels. Subscribe to receive and handle these events. | disallowGetAllChannelMetadata booleanIf enabled, the “Get All Channel Metadata” call is disallowed. If you enable Access Manager and leave this unchecked, you can get all channel metadata without listing it in the token’s permission schema. | disallowGetAllUserMetadata booleanIf enabled, the “Get All User Metadata” call is disallowed. If you enable Access Manager and leave this unchecked, you can get all user metadata without listing it in the token’s permission schema. | referentialIntegrity booleanWhen enabled: you can create a membership only if the specified user ID and channel ID exist as standalone metadata entities. Deleting a user or channel automatically deletes its child membership associations. When disabled: you can create memberships even if the user or channel entity doesn’t exist. Deleting a user or channel doesn’t delete associated memberships. |
| apns objectenabled boolean | teamId stringApple Push Notification service Team ID, 10 characters long | authKeyId stringApple Push Notification service Auth Key ID, 10 characters long | filename stringOriginal filename of the token file. This only serves indentification purposes. |
| fcm objectConnection details for FCM when you use it as a push service provider to deliver push notifications to your application. https://firebase.google.com/docs/cloud-messaging. On the setup, you need to provide the file, you won't be able to retrieve it later from our API. If you need to identify the uploaded configuration, you can use the filename. filename stringOriginal filename of the FCM key file. This only serves identification purposes. |
| messagePersistence objectenabled booleanEnable or disable message persistence | retention numberPossible values: [1, 7, 30, 90, 180, 365, 0] Number of days to retain messages. Valid values: 1, 7, 30, 90, 180, 365, or 0 for unlimited. Align message retention with your File Sharing settings to keep messages and files for the same duration. | includePresenceEvents booleanStore presence event messages in message history. | deleteFromHistory booleanA setting that lets you use API calls to delete specific messages previously stored in a channel's message history. |
| presence objectannounceMax between(0, 100)Possible values: value ≤ 100 Maximum number of occupants in a channel before announcements switch to emitting occupancy counts instead of emitting "join", "leave" and "timeout" events. | interval greaterThanOrEqualTo(10)Possible values: 10 ≤ value Cadence in seconds between each announcement of the channel occupancy. Must be greater than or equal to 10 | deltas booleanIf enabled, adds two fields to invterval event: a list of UUIDs that have joined and left the channel since the last presence interval message. | generateLeaveOnDisconnect booleanTriggers a "leave" event at the closing of the clients connection (for example, when a browser tab closes or an app is force quit). Generates additional billable events. | streamFiltering booleanOnce enabled, filters presence events at the client. You receive only relevant events on the Presence channel (for example, join events for a specific User ID). | activeNoticeChannel stringSends notifications when a channel switches between active (has subscribers) and inactive (no subscribers). | debounce greaterThanOrEqualTo(0)The number of seconds to wait before allowing implicit "joins" after an explicit "leave". Helps smooth out rapid state changes. |
|
|