vx_req_session_send_message
Learn about messaging in Vivox Core.
Read time 2 minutesLast updated 8 months ago
Send a message to all participants in the session. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | session_handle The handle returned from a successful [vx_req_sessiongroup_add_session] request. |
| char * | message_header The HTTP content type of the message. |
| char * | message_body The contents of the message. |
| char * | language The language. |
| char * | application_stanza_namespace A custom application stanza namespace. |
| char * | application_stanza_body A custom application stanza body. |
Detailed Description
struct vx_req_session_send_message;
Send a message to all participants in the session.
Public Attributes Documentation
variable base
vx_req_base_t base;
The common properties for all requests.
variable session_handle
VX_HANDLE session_handle;
The handle returned from a successful [vx_req_sessiongroup_add_session] request.
variable message_header
char * message_header;
The HTTP content type of the message.
Note: This field will be validated, so it must use a valid format. See the IETF documentation on RFC 2046.
If an empty string is passed in, this field defaults to "text/plain".
variable message_body
char * message_body;
The contents of the message.
Note: The message body cannot exceed the length specified by the server in its pre-login configuration. The default maximum message length is 320 bytes (320 characters in UTF-8 encoding).
variable language
char * language;
The language.
Note: V5 only. This is ignored by V4.
The default setting is NULL, which implies "en".
variable application_stanza_namespace
char * application_stanza_namespace;
A custom application stanza namespace.
Note: V5 only. This is ignored by V4.
This is optional. The default setting is NULL.
variable application_stanza_body
char * application_stanza_body;
A custom application stanza body.
Note: V5 only. This is ignored by V4.
This is optional. The default setting is NULL.