You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Delete 0x0126

Resource Delete 0x0126

SwitchKit Name

ResourceDelete

Type

EXS API and SwitchKit API message

Description

Resource Delete 0x0126

Use this message to delete a processing resource.

Deleting a Conference

If forced deletion of a child conference is specified, the child conference is deleted immediately and the parties are connected back to the parent conference. If graceful deletion of a child conference is specified, then the child conference is deleted only after all the parties connected to it are disconnected. If the Forced Delete TLV is not used, graceful deletion is the default behavior.

When you use this message to delete a child conference, you must use the Child Conference ID AIB to address the child conference that needs to be deleted. If the child conference ID is specified as FFFF, then all the child conferences for the particular parent conference are deleted.

Sent by

Host application

Related API Messages

Resource Create (0x0124)

Resource Modify (0x125)

Resource Connect (0x127)

Resource Delete Indication (0x0129)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceDelete;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_ResourceDelete Ack;

C++ Class

class XLC_ResourceDelete : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

// Extended addressing functions

// Conference ID AIB functions

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

void setChildConferenceID(XBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE *getData() const ;

UBYTE *getData();

void setData(UBYTE *x) ;

C++ Class Response

class XLC_ResourceDeleteAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x00NN)
3, 4 | Message Type (0x0126) | 3, 4 | Message Type (0x0126)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB)
Number of AEs to follow | 10 : | AIB (same as message)
AE 0x55 Conference ID 0x45 Child Conference ID | : | Data Type 0x00 TLVs
: | Data Type 0x00 TLVs | : | Number of TLVs to Follow
: | Number of TLVs to Follow | : | TLVs Mandatory Return TLVs 0x0602 Resource Type
: | TLVs | : | Checksum
| Mandatory TLV: 0x0602 Resource Type Optional TLV if AE is Conference and Resource Type is Conference: 0x0611 Forced Flag (Default is Graceful) Optional TLV if AE is Child Conference and Resource Type is Child Conference: 0x0611 Forced Flag (Default is Graceful)
: | Checksum

Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
See Address Information Block.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
Most Significant Bit
Least Significant Bit