# OpalMessage Struct Reference

`#include <opal.h>`

Collaboration diagram for OpalMessage:

[legend]

## Data Fields

OpalMessageType | m_type
| Type of message.
union {
const char * m_commandError
| Used by OpalIndCommandError.
OpalParamGeneral m_general
| Used by OpalCmdSetGeneralParameters.
OpalParamProtocol m_protocol
| Used by OpalCmdSetProtocolParameters.
OpalParamRegistration m_registrationInfo
| Used by OpalCmdRegistration.
OpalStatusRegistration m_registrationStatus
| Used by OpalIndRegistration.
OpalParamSetUpCall m_callSetUp
| Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.
const char * m_callToken
| Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.
OpalStatusIncomingCall m_incomingCall
| Used by OpalIndIncomingCall.
OpalParamAnswerCall m_answerCall
| Used by OpalCmdAnswerCall/OpalCmdAlerting.
OpalStatusUserInput m_userInput
| Used by OpalIndUserInput/OpalCmdUserInput.
OpalStatusMessageWaiting m_messageWaiting
| Used by OpalIndMessageWaiting.
OpalStatusLineAppearance m_lineAppearance
| Used by OpalIndLineAppearance.
OpalStatusCallCleared m_callCleared
| Used by OpalIndCallCleared.
OpalParamCallCleared m_clearCall
| Used by OpalCmdClearCall.
OpalStatusMediaStream m_mediaStream
| Used by OpalIndMediaStream/OpalCmdMediaStream.
OpalParamSetUserData m_setUserData
| Used by OpalCmdSetUserData.
OpalParamRecording m_recording
| Used by OpalCmdStartRecording.
OpalStatusTransferCall m_transferStatus
| Used by OpalIndTransferCall.
OpalStatusIVR m_ivrStatus
| Used by OpalIndCompletedIVR.
OpalPresenceStatus m_presenceStatus
| used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence
OpalInstantMessage m_instantMessage
| Used by OpalCmdSendIM/OpalIndReceiveIM.
} | m_param

## Detailed Description

Message to/from OPAL system. This is passed via the OpalGetMessage() or OpalSendMessage() functions.

## Field Documentation

OpalParamAnswerCall OpalMessage::m_answerCall

Used by OpalCmdAnswerCall/OpalCmdAlerting.

OpalStatusCallCleared OpalMessage::m_callCleared

Used by OpalIndCallCleared.

OpalParamSetUpCall OpalMessage::m_callSetUp

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

const char* OpalMessage::m_callToken

Used by OpalCmdHoldcall/OpalCmdRetrieveCall/OpalCmdStopRecording.

OpalParamCallCleared OpalMessage::m_clearCall

Used by OpalCmdClearCall.

const char* OpalMessage::m_commandError

Used by OpalIndCommandError.

OpalParamGeneral OpalMessage::m_general

Used by OpalCmdSetGeneralParameters.

OpalStatusIncomingCall OpalMessage::m_incomingCall

Used by OpalIndIncomingCall.

OpalInstantMessage OpalMessage::m_instantMessage

Used by OpalCmdSendIM/OpalIndReceiveIM.

OpalStatusIVR OpalMessage::m_ivrStatus

Used by OpalIndCompletedIVR.

OpalStatusLineAppearance OpalMessage::m_lineAppearance

Used by OpalIndLineAppearance.

OpalStatusMediaStream OpalMessage::m_mediaStream

Used by OpalIndMediaStream/OpalCmdMediaStream.

OpalStatusMessageWaiting OpalMessage::m_messageWaiting

Used by OpalIndMessageWaiting.

union { ... } OpalMessage::m_param

OpalPresenceStatus OpalMessage::m_presenceStatus

used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence

OpalParamProtocol OpalMessage::m_protocol

Used by OpalCmdSetProtocolParameters.

OpalParamRecording OpalMessage::m_recording

Used by OpalCmdStartRecording.

OpalParamRegistration OpalMessage::m_registrationInfo

Used by OpalCmdRegistration.

OpalStatusRegistration OpalMessage::m_registrationStatus

Used by OpalIndRegistration.

OpalParamSetUserData OpalMessage::m_setUserData

Used by OpalCmdSetUserData.

OpalStatusTransferCall OpalMessage::m_transferStatus

Used by OpalIndTransferCall.

OpalMessageType OpalMessage::m_type

Type of message.

OpalStatusUserInput OpalMessage::m_userInput

Used by OpalIndUserInput/OpalCmdUserInput.

The documentation for this struct was generated from the following file:

- opal.h