Skip to content

Latest commit

 

History

History
52 lines (45 loc) · 3.84 KB

GroupChannelMessageSendRequest.md

File metadata and controls

52 lines (45 loc) · 3.84 KB

GroupChannelMessageSendRequest

Properties

Name Type Description Notes
fromUserId string Sender user ID. Server-side sending does not require the sender to be a group member, but push display works best when the sender has an access token. [default to undefined]
toChannelIds Array<string> Target group channel IDs. Up to 3 groups are supported per request. Targeted messages support only one group. [default to undefined]
toUserIds Array<string> Recipient member user IDs for a targeted group message. Only effective when sending to a single group. [optional] [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 serialized as a string. Built-in message types should use a JSON object string. Maximum size is 128 KB. [default to undefined]
pushContent string Push notification text for offline recipients. Optional for built-in user content messages and required for push-enabled custom or notification messages. [optional] [default to undefined]
pushData string Custom push payload data. Exposed as `appData` on mobile push payloads. [optional] [default to undefined]
isEchoToSender number Whether to sync the sent message to the sender&#39;s client while online. `1` enables sync and `0` disables it. [optional] [default to undefined]
shouldPersist number Whether to store the message in cloud message history. `0` means do not store and `1` means store. [optional] [default to undefined]
hasMention number Whether this is an @mention message. Set to `1` when `content` contains `mentionedInfo`. [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 for this message. Only effective when sending to a single group channel. [optional] [default to undefined]
metadata { [key: string]: any; } Custom message metadata entries. Only effective when `hasMetadata` is `true` and the request targets a single group. [optional] [default to undefined]
disablePush boolean Whether to suppress push notifications. Only effective when the request targets a single group channel. [optional] [default to undefined]
pushExt string Extended push configuration (JSON string as accepted by `GroupChannelMsgSendInput`). [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 { GroupChannelMessageSendRequest } from '@nexconn/server-sdk';

const instance: GroupChannelMessageSendRequest = {
    fromUserId,
    toChannelIds,
    toUserIds,
    messageType,
    content,
    pushContent,
    pushData,
    isEchoToSender,
    shouldPersist,
    hasMention,
    contentAvailable,
    hasMetadata,
    metadata,
    disablePush,
    pushExt,
    disableUpdateLastMsg,
    needReadReceipt,
};

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