SAP ABAP Class CL_BCB_PHONE_CALL (BCB Phone Call)

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_PHONE_CALL_CONSTANTS	BCB Phone Call Constants	20031126
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_PHONE_CALL_PROPS_ACCESS	BCB Phone Call Properties Access	20031125

Properties

Class	CL_BCB_PHONE_CALL
Short Description	BCB Phone Call
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_PHONE_CALL_CONSTANTS	☐	☐	BCB Phone Call Constants	20031126
2	IF_BCB_PHONE_CALL_PROPS_ACCESS	☐	☐	BCB Phone Call Properties Access	20031125

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BCB_PHONE_LINE	☐	20031117	BCB Phone Line

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CA_ALTERNATE	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
2	CA_CONFERENCE	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
3	CA_CONSULT	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
4	CA_DIAL	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
5	CA_DROP	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
6	CA_DROPPARTY	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
7	CA_DTMF	Instance attribute	Public	☐	Attribute reference (LIKE)				20070207
8	CA_HOLD	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
9	CA_LISTEN	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
10	CA_LISTENEND	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
11	CA_RECONNECT	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
12	CA_TRANSFER	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
13	CA_UNHOLD	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
14	IS_BUSY	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
15	IS_CONFERENCE_OWNER	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
16	IS_CONFERENCE_PARTICIPANT	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
17	IS_CONNECTED	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
18	IS_DIALING	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
19	IS_HELD	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
20	IS_HOLD	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
21	IS_IDLE	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
22	IS_LISTENED	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
23	IS_PREVIEW	Instance attribute	Public	☐	Attribute reference (LIKE)				20081115
24	IS_RINGING	Instance attribute	Public	☐	Attribute reference (LIKE)				20031126
25	M_CHANNEL_CAPABILITY_OFFSET	Constant	Private	☐	Type reference (TYPE)	INT2	100	2 byte integer (signed)	20040202
26	M_CHANNEL_CAPABILITY_TEXT	Static Attribute	Private	☐	Type reference (TYPE)	STRING_TABLE		Capabilities Texts	20031126
27	M_DIALED_NUMBER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS			20031126
28	M_ICI_PHONE_CALL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ICI_PHONE_CALL		ICI Interface Object	20031120
29	M_INBOUND	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20031126
30	M_INTERNAL	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20031126
31	M_IS_CONFERENCED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20031201
32	M_LINE_NUMBER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS			20031126
33	M_REMOTE_NUMBERS	Instance attribute	Private	☐	Type reference (TYPE)	BCB_PHONE_ADDRESS_REF_T			20031126
34	M_TRUNK_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20031126
35	M_WAS_CONNECTED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20031126
36	NS_CONFERENCE	Instance attribute	Public	☐	Attribute reference (LIKE)				20031201
37	NS_RECONNECT	Instance attribute	Public	☐	Attribute reference (LIKE)				20031201
38	NS_TRANSFER	Instance attribute	Public	☐	Attribute reference (LIKE)				20031201
39	NS_UNKNOWN	Instance attribute	Public	☐	Attribute reference (LIKE)				20031201

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ALTERNATE	Instance method	Public	Method	Sets this call on hold and connect to specified held call	20031201
2	CHECK_CAPABILITY	Static method	Public	Method	Check capability is a valid phone call capability	20031201
3	CHECK_STATUS	Static method	Public	Method	Check if status is a valid phone call status	20031126
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20031117
5	CONFERENCE	Instance method	Public	Method	Creates a conference between this connected call and a held	20031201
6	CONSULT	Instance method	Public	Method	Create a new consult call and set this call on hold	20031205
7	CREATE_BY_ID	Static method	Public	Method	Create a phone call (public)	20031117
8	CREATE_BY_PHONE_LINE	Static method	Protected	Method	Create a phone call (within phone line)	20031218
9	CREATE_BY_PHONE_LINE_AND_ID	Static method	Protected	Method	Create a phone call (within phone line)	20031218
10	CREATE_BY_PHONE_LINE_AND_PROPS	Static method	Protected	Method	Create a phone call (within phone line)	20031218
11	DIAL	Instance method	Public	Method	Open a new phone call connection	20031205
12	DROP	Instance method	Public	Method	End phone call	20031205
13	DROP_PARTY	Instance method	Public	Method	Remove remote party from phone conference	20031205
14	GET_DIALED_NUMBER	Instance method	Public	Method	Returns dialed number (= container ID) of this phone call	20031118
15	GET_LINE_NUMBER	Instance method	Public	Method	Returns the line number (= container ID) of the phone line	20031118
16	GET_REMOTE_NUMBERS	Instance method	Public	Method	Returns the remote number(s) of this phone call	20031118
17	GET_TRUNK_ID	Instance method	Public	Method	Trunk ID	20031118
18	HOLD	Instance method	Public	Method	Sets a call in the hold status	20031208
19	INITIALIZE	Instance method	Private	Method	Initialize phone call instance	20031117
20	INITIALIZE_STATICS	Static method	Private	Method	Initialize static members	20040202
21	IS_CONFERENCED	Instance method	Public	Method	Is current call status conference_owner or ~_participant?	20031201
22	IS_INBOUND	Instance method	Public	Method	Returns true if the remote party has created the call	20031209
23	IS_INTERNAL	Instance method	Public	Method	Returns true if all remoteNumbers represent internal numbers	20031211
24	LISTEN	Instance method	Public	Method	Connect to an existing phone call for listining purposes	20031208
25	LISTEN_END	Instance method	Public	Method	Ends a listening process	20031208
26	RECONNECT	Instance method	Public	Method	Switches the specified held call to connected again	20031208
27	SAME_NUMBERS	Instance method	Public	Method	Check equality of a list of numbers	20031209
28	SENDDTMF	Instance method	Public	Method		20060426
29	TRANSFER	Instance method	Public	Method	Transfer a held call	20031209
30	UNHOLD	Instance method	Public	Method	Switches a call (back) in the connect status	20031209
31	UPDATE	Instance method	Public	Method	User-Attribute ändern	20031118
32	WAS_CONNECTED	Instance method	Public	Method	Was status of this call at least once "connected"?	20031201

Events

Class CL_BCB_PHONE_CALL has no event.

Types

Class CL_BCB_PHONE_CALL has no local type.

Method Signatures

Method ALTERNATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HELD_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031201

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031201

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			20031201

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031201

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			20031126

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031126

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_BCB_PHONE_CALL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_BCB_PHONE_CALL has no exception.

Method CONFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HELD_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031201

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031201

Method CONSULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONSULT_CALL	Value transfer	☑	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20040519
2	Importing	DIAL_NUMBER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS			20031205
3	Importing	NEXT_STEP	Call by reference	☐	Type reference (TYPE)	INT2			20031205
4	Returning	PHONE_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031205

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031205

Method CREATE_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☐	Type reference (TYPE)	STRING			20031117
2	Returning	PHONE_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031117
3	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION			20031117

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031117

Method CREATE_BY_PHONE_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PHONE_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031218
2	Importing	PHONE_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_LINE			20031218
3	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION			20031218
4	Importing	UPDATE_PROPS	Value transfer	☑	Type reference (TYPE)	BOOLEAN		Boolesche Variable (X=wahr, -=falsch, leer=unbekannt)	20040526

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031218

Method CREATE_BY_PHONE_LINE_AND_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☐	Type reference (TYPE)	STRING			20031218
2	Returning	PHONE_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031218
3	Importing	PHONE_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_LINE			20031218
4	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION			20031218

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031218

Method CREATE_BY_PHONE_LINE_AND_PROPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PHONE_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031218
2	Importing	PHONE_CALL_PROPS	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL_PROPS			20031218
3	Importing	PHONE_LINE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_LINE			20031218
4	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION			20031218

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031218

Method DIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIAL_NUMBER	Value transfer	☑	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS			20031205
2	Importing	DIAL_NUMBER_STRING	Value transfer	☑	Type reference (TYPE)	STRING		Telefonnummer	20031205

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031205

Method DROP Signature

Method DROP on class CL_BCB_PHONE_CALL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031205

Method DROP_PARTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARTY	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS			20031205

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031205

Method GET_DIALED_NUMBER Signature

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

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method GET_LINE_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LINE_NUMBER	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_ADDRESS		Zeilennummer	20031118

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method GET_REMOTE_NUMBERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REMOTE_NUMBERS	Value transfer	☐	Type reference (TYPE)	BCB_PHONE_ADDRESS_REF_T			20031118

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031211

Method GET_TRUNK_ID Signature

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

Method GET_TRUNK_ID on class CL_BCB_PHONE_CALL has no exception.

Method HOLD Signature

Method HOLD on class CL_BCB_PHONE_CALL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method INITIALIZE Signature

Method INITIALIZE on class CL_BCB_PHONE_CALL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method INITIALIZE_STATICS Signature

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

Method IS_CONFERENCED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_CONFERENCED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031201

Method IS_CONFERENCED on class CL_BCB_PHONE_CALL has no exception.

Method IS_INBOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_INBOUND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031209

Method IS_INBOUND on class CL_BCB_PHONE_CALL has no exception.

Method IS_INTERNAL Signature

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

Method IS_INTERNAL on class CL_BCB_PHONE_CALL has no exception.

Method LISTEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LISTENER_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_CONTAINER			20031208

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method LISTEN_END Signature

Method LISTEN_END on class CL_BCB_PHONE_CALL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method RECONNECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HELD_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031208

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031208

Method SAME_NUMBERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NUMBERS_TO_BE_CHECKED	Value transfer	☐	Type reference (TYPE)	BCB_PHONE_NUMBER_T			20031209
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031209

Method SENDDTMF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DTMF_TONE	Value transfer	☐	Type reference (TYPE)	STRING			20060426

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20060426

Method TRANSFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HELD_CALL	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL			20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031209

Method UNHOLD Signature

Method UNHOLD on class CL_BCB_PHONE_CALL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031209

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PHONE_CALL_CHANGES	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL_CHANGES			20031118
2	Importing	PHONE_CALL_PROPS	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_PHONE_CALL_PROPS			20031120

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031211

Method WAS_CONNECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WAS_CONNECTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031201

Method WAS_CONNECTED on class CL_BCB_PHONE_CALL has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in