SAP ABAP Class CL_CRM_MCM_CHAT_CHANNEL (MCM chat channel)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-CHA (Application Component) Communication Channel
     ⤷ IC_CCS_MCM (Package) IC Communication Channels Service Multi-Channel Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CRM_MCM_CHANNEL	MCM Channel (telephone, mail and chat)	20031024
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CHAT_CONSTANTS	BCB Chat Session Constants	20040122
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_ITEM_CONSTANTS	Bcb Item Constants	20050126
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CRM_MCM_CHAT_CONSTANTS	MCM Chat Session Constants	20040122

Properties

Class	CL_CRM_MCM_CHAT_CHANNEL
Short Description	MCM chat channel
Super Class	CL_CRM_MCM_CHANNEL	MCM Channel (telephone, mail and chat)
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	IC_CCS_MCM	IC Communication Channels Service Multi-Channel Management
Created	20031024	SAP
Last change	20100303	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BCB_CHAT_CONSTANTS	☐	☐	BCB Chat Session Constants	20040122
2	IF_BCB_ITEM_CONSTANTS	☐	☐	Bcb Item Constants	20050126
3	IF_CRM_MCM_CHAT_CONSTANTS	☐	☐	MCM Chat Session Constants	20040122

Friends

Class CL_CRM_MCM_CHAT_CHANNEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_CLEAR_ALERT_POSTINGS	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20040122
2	M_CLIENT_VISIBLE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20040122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	constructor	20031106
2	CREATE_CHAT_SESSION	Instance method	Public	Method	Create Chat Session	20081107
3	GET_CHAT_ATTACHED_DATA	Instance method	Public	Method	get chat session attached_data	20050114
4	GET_CHAT_SESSION_DIALOG	Instance method	Public	Method	get chat session dialog	20040123
5	GET_CHAT_SESSION_PARTICIPANTS	Instance method	Public	Method	get chat session participants	20050114
6	GET_CHAT_SESSION_STATUS	Instance method	Public	Method	get chat session status	20040123
7	GET_CHAT_SESSION_TITLE	Instance method	Public	Method	get chat session title	20040123
8	GET_CHAT_TYPE	Instance method	Public	Method	Get the chat type	20090603
9	GET_CURRENT_CHAT_SESSION_ID	Instance method	Public	Method	get current chat session id	20040123
10	HANDLE_NEW_POSTING	Instance method	Public	Method	handle new chat posting	20040122
11	INSERT_INPUT_TEXT	Instance method	Public	Method	insert text	20040123
12	IS_VALID_ADDRESS	Static method	Public	Method	check address	20031229
13	LEAVE_CHAT_SESSION	Instance method	Public	Method	remove chat session	20080725
14	POST_CHAT_SESSION_MESSAGE	Instance method	Public	Method	post message	20040123
15	REMOVE_CHAT_SESSION	Instance method	Public	Method	remove chat session	20050215
16	SET_CLIENT_VISIBLE	Instance method	Public	Method	set client to visible	20040123
17	SET_MCM_CHAT_SESSION	Instance method	Public	Method	Append a new line to the chat sessions table	20081011

Events

Class CL_CRM_MCM_CHAT_CHANNEL has no event.

Types

Class CL_CRM_MCM_CHAT_CHANNEL has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MCM_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_MCM_SESSION		MCM Session	20031106

Method CONSTRUCTOR on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method CREATE_CHAT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTACHED_DATA	Call by reference	☑	Type reference (TYPE)	STRING		Attached Data	20081211
2	Importing	IV_CHAT_ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING		Chat Address	20081107
3	Importing	IV_CHAT_TYPE	Call by reference	☐	Type reference (TYPE)	CRM_IC_MCM_CHAT_TYPE	001	MCM Chat Type	20081107
4	Importing	IV_IM_PROPERTIES	Call by reference	☑	Type reference (TYPE)	CRMS_IC_MCM_IM_IAD		MCM IM properties	20090103
5	Returning	RV_MCM_CHAT_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_MCM_CHAT_SESSION		MCM Chat Session	20081107

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM exception	20081107

Method GET_CHAT_ATTACHED_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20050114
2	Returning	PARTICIPANTS	Value transfer	☐	Type reference (TYPE)	STRING			20050114

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐		20050114

Method GET_CHAT_SESSION_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040123
2	Returning	DIALOG	Value transfer	☐	Type reference (TYPE)	STRING			20040123

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM Ausnahme	20040123

Method GET_CHAT_SESSION_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20050114
2	Returning	PARTICIPANTS	Value transfer	☐	Type reference (TYPE)	STRING			20050114

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐		20050114

Method GET_CHAT_SESSION_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040123
2	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	STRING			20040123

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM Ausnahme	20040123

Method GET_CHAT_SESSION_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040123
2	Returning	TITLE	Value transfer	☐	Type reference (TYPE)	STRING			20040123

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM Ausnahme	20040123

Method GET_CHAT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XML_STRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20090603
2	Returning	RS_IM_IAD	Value transfer	☐	Type reference (TYPE)	CRMS_IC_MCM_IM_IAD		Multi Channel Management (MCM) Chat Type	20090603

Method GET_CHAT_TYPE on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method GET_CURRENT_CHAT_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040123

Method GET_CURRENT_CHAT_SESSION_ID on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method HANDLE_NEW_POSTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_POSTING	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_POSTING		BCB Chat Posting	20040122
2	Importing	CHAT_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_MCM_CHAT_SESSION		MCM Chat Session	20040122

Method HANDLE_NEW_POSTING on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method INSERT_INPUT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20040123

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM Ausnahme	20040123

Method IS_VALID_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING			20031229
2	Returning	IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031229

Method IS_VALID_ADDRESS on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method LEAVE_CHAT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20080725

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM exception	20080725

Method POST_CHAT_SESSION_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20040123
2	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040123

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM Ausnahme	20040123

Method REMOVE_CHAT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20050215

#	Exception	Resumable	Description	Created on
1	CX_CRM_MCM_EXCEPTION	☐	MCM exception	20050216

Method SET_CLIENT_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT_VISIBLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20040123

Method SET_CLIENT_VISIBLE on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

Method SET_MCM_CHAT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHAT_SESSION	Call by reference	☐	Type reference (TYPE)	CRMS_IC_MCM_CHAT_SESSION		MCM interaction id - session id map	20081011

Method SET_MCM_CHAT_SESSION on class CL_CRM_MCM_CHAT_CHANNEL has no exception.

History

Last changed by/on	SAP	20100303
SAP Release Created in