@twilio/voice-react-native-sdk
Version:
Twilio Voice React Native SDK
54 lines (53 loc) • 1.43 kB
TypeScript
/**
* Copyright © 2022 Twilio, Inc. All rights reserved. Licensed under the Twilio
* license.
*
* See LICENSE in the project root for license information.
*/
/**
* The constituent values of a Call Message.
*
* @public
*/
export interface CallMessage {
/**
* The content of the message. This value should match the content type
* parameter.
*
* See {@link CallMessage.contentType} for more information.
*/
content: any;
/**
* The content type of the message. This value should accurately describe
* the content of the message. The following values are accepted:
*
* - "application/json"
*
* If no value is defined, then the default value of "application/json" will
* be used.
*
* If the `contentType` of the message is "application/json", the content
* of the message may be a JS object.
*/
contentType?: string;
/**
* The message type. The following values are accepted:
*
* - "user-defined-message"
*/
messageType: string;
}
/**
* Parse CallMessage values. Used when constructing a CallMessage from the
* native layer, or by the Call and CallInvite classes when sending a
* CallMessage.
*
* @param message the CallMessage details.
*
* @internal
*/
export declare function validateCallMessage(message: CallMessage): {
content: string;
contentType: string;
messageType: string;
};