SAP ABAP Class CL_CLB2_SESSION (SAIL: Session description)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ CLB2_PROCESS (Package) Process Layer of the Collaboration Platform Library

Properties

Class	CL_CLB2_SESSION
Short Description	SAIL: Session description
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CLB2_PROCESS	Process Layer of the Collaboration Platform Library
Created	20130516	SAP
Last change	20131127	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

Class CL_CLB2_SESSION has no interface implemented.

Friends

Class CL_CLB2_SESSION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MS_TOKEN_DATA	Instance attribute	Private	☐	Type reference (TYPE)	CLB2_S_USER_TOKEN_DATA		CLAS CL_CLB2_SESSION	20130516
2	MV_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130516
3	MV_IS_TOKEN	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130516
4	MV_KEY	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130516

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_TOKEN_DATA	Instance method	Public	Method	Get a token data structure	20130516
2	ID	Instance method	Public	Method	Get the session ID	20130516
3	INIT	Instance method	Public	Method	Initialize a session	20130516
4	INIT_TOKEN	Instance method	Protected	Method	Initialize a token	20130516
5	IS_TOKEN	Instance method	Public	Method	Get if the session is identified by a token or a session ID	20130516
6	IS_VALID	Instance method	Public	Method	Get if the session is valid	20130516
7	KEY	Instance method	Public	Method	Get the key of the session ID in the URL	20130516
8	SET_SESSION_DATA	Instance method	Public	Method	Set the XML from the response of the session target	20130516
9	SET_TOKEN_DATA	Instance method	Public	Method	Set the XML from the response of an access_token call	20130516

Events

Class CL_CLB2_SESSION has no event.

Types

Class CL_CLB2_SESSION has no local type.

Method Signatures

Method GET_TOKEN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	CLB2_S_USER_TOKEN_DATA		Data Structure of Table CLB2_USER_TOKEN	20130516

Method GET_TOKEN_DATA on class CL_CLB2_SESSION has no exception.

Method ID Signature

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

Method ID on class CL_CLB2_SESSION has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TOKEN_DATA	Call by reference	☑	Type reference (TYPE)	CLB2_S_USER_TOKEN_DATA		Data Structure of Table CLB2_USER_TOKEN	20130516
2	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	STRING		ID of the user of this session	20130516

Method INIT on class CL_CLB2_SESSION has no exception.

Method INIT_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TOKEN_DATA	Call by reference	☐	Type reference (TYPE)	CLB2_S_USER_TOKEN_DATA		Access Token for OAuth	20130516

Method INIT_TOKEN on class CL_CLB2_SESSION has no exception.

Method IS_TOKEN Signature

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

Method IS_TOKEN on class CL_CLB2_SESSION has no exception.

Method IS_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Boolean Variable (X=True, -=False, Space=Unknown)	20130516

Method IS_VALID on class CL_CLB2_SESSION has no exception.

Method KEY Signature

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

Method KEY on class CL_CLB2_SESSION has no exception.

Method SET_SESSION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20130516

Method SET_SESSION_DATA on class CL_CLB2_SESSION has no exception.

Method SET_TOKEN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XDATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20130516

Method SET_TOKEN_DATA on class CL_CLB2_SESSION has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	100