Skip to content

DirectChannelMessageSendRequest.md

Latest commit

 

History

History
52 lines (45 loc) · 3.7 KB

DirectChannelMessageSendRequest.md

File metadata and controls

52 lines (45 loc) · 3.7 KB
Raw

DirectChannelMessageSendRequest

Properties

Name Type Description Notes
fromUserId string Sender user ID. The sender should have an access token so push notifications can display sender information correctly. [default to undefined]
toUserIds Array<string> Recipient user IDs. Up to 1000 users are supported in a single request. [default to undefined]
messageType string Message type. Supports built-in types and custom types registered in the client SDK. Custom types must not start with `RC:` and must not exceed 32 characters. [default to undefined]
content string Message content payload. Built-in message types should pass a JSON object serialized as a string. Maximum size is 128 KB. [default to undefined]
pushContent string Push notification text shown to offline recipients. Required for custom message types or notification/signal messages that need push delivery. [optional] [default to undefined]
pushData string Custom payload included in the push notification. Exposed as `appData` on iOS and Android. [optional] [default to undefined]
isEchoToSender number Whether to sync the message to the sender&#39;s client while the sender is online. `1` enables sync and `0` disables it. [optional] [default to undefined]
count number Aligns with Java `DirectChannelMsgSendInput.count` (push/badge-related counter field name in server model). [optional] [default to undefined]
verifyBlocklist number Whether to filter recipients against the sender&#39;s blocklist. `0` means no filtering and `1` means filter blocked users out. [optional] [default to undefined]
shouldPersist number Whether to store the message in recipient cloud history. `0` means do not store and `1` means store. [optional] [default to undefined]
contentAvailable number iOS silent-push flag. `1` enables background delivery and `0` disables it. [optional] [default to undefined]
hasMetadata boolean Whether to enable message metadata (message expansion) for this message. [optional] [default to undefined]
metadata { [key: string]: any; } Custom message metadata entries. Keys are limited to 32 characters and values to 4096 characters. [optional] [default to undefined]
disablePush boolean Whether to suppress push notifications for offline recipients. [optional] [default to undefined]
pushExt string Extended push configuration (JSON string as accepted by `DirectChannelMsgSendInput`). [optional] [default to undefined]
disableUpdateLastMsg boolean Whether to keep this message from updating the channel&#39;s last-message preview. [optional] [default to undefined]
needReadReceipt number Whether to request read receipts for this persisted message. `1` requests read receipts and `0` disables them. [optional] [default to undefined]

Example

import { DirectChannelMessageSendRequest } from '@nexconn/server-sdk';

const instance: DirectChannelMessageSendRequest = {
    fromUserId,
    toUserIds,
    messageType,
    content,
    pushContent,
    pushData,
    isEchoToSender,
    count,
    verifyBlocklist,
    shouldPersist,
    contentAvailable,
    hasMetadata,
    metadata,
    disablePush,
    pushExt,
    disableUpdateLastMsg,
    needReadReceipt,
};

[Back to Model list] [Back to API list] [Back to README]