SAP ABAP Class CL_BCB_CHAT_SESSION (BCB Chat Session)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-CHA (Application Component) Communication Channel
     ⤷ ICI_BCB (Package) Business Communication Broker

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BCB_ITEM	BCB Item	20031113
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CHAT_CONSTANTS	BCB Chat Session Constants	20040126
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CHAT_SESSN_PROPS_ACCESS	BCB Chat Session Properties Access	20040126

Properties

Class	CL_BCB_CHAT_SESSION
Short Description	BCB Chat Session
Super Class	CL_BCB_ITEM	BCB Item
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	ICI_BCB	Business Communication Broker
Created	20031113	SAP
Last change	20130531	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)
2	BCB	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	20040126
2	IF_BCB_CHAT_SESSN_PROPS_ACCESS	☐	☐	BCB Chat Session Properties Access	20040126

Friends

#	Friend	Modeled only	Created on	Description
1	IF_BCB_CHAT_SESSION_ACCESS	☐	20040126	BCB Chat Session Access

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CA_CONFERENCEREQUEST	Instance attribute	Public	☐	Attribute reference (LIKE)				20040126
2	CA_JOIN	Instance attribute	Public	☐	Attribute reference (LIKE)				20040126
3	CA_LEAVE	Instance attribute	Public	☐	Attribute reference (LIKE)				20040126
4	CA_POSTMESSAGE	Instance attribute	Public	☐	Attribute reference (LIKE)				20040126
5	IS_CONNECTED	Instance attribute	Public	☐	Attribute reference (LIKE)				20040126
6	IS_INVITING	Instance attribute	Public	☐	Attribute reference (LIKE)				20081126
7	M_CHANNEL_CAPABILITY_OFFSET	Constant	Private	☐	Type reference (TYPE)	INT2	300	2 byte integer (signed)	20040202
8	M_CHANNEL_CAPABILITY_TEXT	Static Attribute	Private	☐	Type reference (TYPE)	STRING_TABLE		Capabilities Texts	20040126
9	M_ICI_CHAT_SESSION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ICI_CHAT_SESSION		ICI Outbount interface	20040126
10	M_PARTICIPANTS	Instance attribute	Protected	☐	Type reference (TYPE)	BCB_CHAT_ADDRESS_REF_T		List of participants' addresses	20040126
11	M_TITLE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Title of the chat session	20040126

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CAPABILITY	Static method	Public	Method	Check capability value is a valid chat session capability	20031209
2	CHECK_STATUS	Static method	Public	Method	Check Chat Session Status	20031209
3	CONFERENCE	Instance method	Public	Method	Includes another user into this chat session	20040126
4	CREATE_BY_CHAT_LINE	Static method	Public	Method	Create a chat session for a given chat line	20081010
5	CREATE_BY_CHAT_LINE_AND_PROPS	Static method	Protected	Method	Creates a chat session within a given chat line container	20040126
6	CREATE_BY_ID	Static method	Public	Method	Create a chat session for a given chat line	20040126
7	GET_CHAT_LINE	Instance method	Public	Method	Get chat line	20040122
8	GET_DIALOG	Instance method	Public	Method	get chat posting dialog	20040122
9	GET_NUMBER_OF_PARTICIPANTS	Instance method	Private	Method	Returns the number of participants in the chat	20040126
10	GET_PARTICIPANTS	Instance method	Public	Method	Get participants of the chat session	20040122
11	GET_TITLE	Instance method	Public	Method	get chat session title	20040123
12	INITIALIZE	Instance method	Private	Method	Initialize phone call instance	20040126
13	INITIALIZE_STATICS	Static method	Private	Method	Initialize static members	20040202
14	INVITE	Instance method	Public	Method	Initiates a chat session with other participants	20081107
15	JOIN	Instance method	Public	Method	Includes another user into this chat session	20040126
16	LEAVE	Instance method	Public	Method	Ends a chat participation on a chat session	20040122
17	POST_MESSAGE	Instance method	Public	Method	Sends a text message to all other chat participants	20040122
18	SAME_PARTICIPANTS	Instance method	Public	Method	Check equality of a list of participants' addresses	20040126
19	UPDATE	Instance method	Public	Method	Update Chat Session Attributes	20040126

Events

Class CL_BCB_CHAT_SESSION has no event.

Types

Class CL_BCB_CHAT_SESSION has no local type.

Method Signatures

Method CHECK_CAPABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CAPABILITY	Value transfer	☐	Type reference (TYPE)	INT2		Capability to be checked	20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031209

Method CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATUS	Value transfer	☐	Type reference (TYPE)	STRING		Status to be checked	20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031209

Method CONFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_PARTICIPANT	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_ADDRESS		The new user's address	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method CREATE_BY_CHAT_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_LINE		BCB Chat Line	20081010
2	Returning	CHAT_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION		BCB Chat Session	20081010
3	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20081010

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20081010

Method CREATE_BY_CHAT_LINE_AND_PROPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHAT_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_LINE		BCB Chat Line	20040126
2	Returning	CHAT_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION		BCB Chat Session	20040126
3	Importing	CHAT_SESSION_PROPS	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION_PROPS		BCB Chat Session Properties	20040126
4	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method CREATE_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHAT_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION		BCB Chat Session	20040126
2	Importing	ID	Value transfer	☐	Type reference (TYPE)	STRING		BCB Item ID	20040126
3	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method GET_CHAT_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHAT_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_ADDRESS			20040122

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20040122

Method GET_DIALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	POSTINGS	Value transfer	☐	Type reference (TYPE)	BCB_CHAT_POSTING_REF_T			20040122

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20040122

Method GET_NUMBER_OF_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NUMBER_OF_PARTICIPANTS	Value transfer	☐	Type reference (TYPE)	I			20040126

Method GET_NUMBER_OF_PARTICIPANTS on class CL_BCB_CHAT_SESSION has no exception.

Method GET_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARTICIPANTS	Value transfer	☐	Type reference (TYPE)	BCB_CHAT_ADDRESS_REF_T			20040122

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20040122

Method GET_TITLE Signature

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

Method GET_TITLE on class CL_BCB_CHAT_SESSION has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CREATE_MODE	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20081126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method INITIALIZE_STATICS Signature

Method INITIALIZE_STATICS on class CL_BCB_CHAT_SESSION has no parameter.
Method INITIALIZE_STATICS on class CL_BCB_CHAT_SESSION has no exception.

Method INVITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHAT_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Chat Participants	20081107
2	Importing	IV_CHAT_TITLE	Call by reference	☐	Type reference (TYPE)	STRING		Chat Subject	20081107

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20081107

Method JOIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NEW_PARTICIPANT	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_ADDRESS		The new user's address	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method LEAVE Signature

Method LEAVE on class CL_BCB_CHAT_SESSION has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20040122

Method POST_MESSAGE 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			20040122

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20040122

Method SAME_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARTICIPANTS_TO_BE_CHECKED	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Participants to be checked	20040126
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		True if numbers are equal	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHAT_SESSION_CHANGES	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION_CHANGES		Phone Call Changes	20040126
2	Importing	CHAT_SESSION_PROPS	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CHAT_SESSION_PROPS		ICI Phone Call	20040126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040126

History

Last changed by/on	SAP	20130531
SAP Release Created in