oracle.live.api

Class CommunicationFragment

java.lang.Object

Fragment

oracle.live.api.CommunicationFragment

public class CommunicationFragment
extends Fragment

CommunicationFragment is an entrance for application to work with Live experience cloud. You can create an Fragment instance and append to your Activity.

Here is an example, you should put similar code to your Activity class.

 
 final String FRAGMENT_TAG = CommunicationFragment.class.getName();

 // Specify the settings for component behavior.
 CommunicationFragment.settings.startVideoInFullScreen = true;
 CommunicationFragment.settings.startVideoWithFrontCamera = true;

 // Specify the settings for the service.
 CommunicationFragment.service.setAddress("Cloud_server_address");
 CommunicationFragment.service.setUserID("Your_user_id");
 CommunicationFragment.service.setTenantID("Your_tenant_key");
 CommunicationFragment.service.setAuthToken("Your_auth_token");
 CommunicationFragment.service.setLanguage("Your_locale");

 // Specify optional information about the customer

 // "appLocation" context attribute is used to match configured engagement scenario.
 CommunicationFragment.contextAttributes.set("appLocation", "Basic Guidance");
 CommunicationFragment.contextAttributes.set("fullName", "Macy Williams");
 CommunicationFragment.contextAttributes.set("email", "macy.williame@example.com");
 CommunicationFragment.contextAttributes.set("phone", "+16505550121");
 CommunicationFragment.contextAttributes.set("location", "San Francisco CA, United States");

 final FragmentManager manager = getSupportFragmentManager();

 CommunicationFragment fragment = (CommunicationFragment) manager.findFragmentByTag(FRAGMENT_TAG);

 if (fragment == null) {
   fragment = CommunicationFragment.newInstance();
   manager.beginTransaction()
          .add(R.id.cx_container, fragment, FRAGMENT_TAG)
          .commit();
 }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static ContextAttributes	contextAttributes End user context attribute settings.
static String	IS_IN_APP_CALL_RINGING If it's the in-app call ringing.
static int	PERMISSION_SCREEN_CAPTURE Screen capture request code.
static Service	service Service settings.
static Settings	settings Component UI behavior settings.

Constructor Summary

Constructors

Constructor and Description
CommunicationFragment()

Method Summary

Modifier and Type	Method and Description
static CommunicationFragment	newInstance() Create new CommunicationFragment instance.
static void	setClientInfo(ClientInfo clientInfo, android.content.Context context) Set client information.
static void	setMeetingURL(String meetingURL) Set meeting URL for a meeting call.
static void	setNotificationContent(Map notificationData, android.content.Context context, Class cls) Set in-app call content.
static void	setScreenCaptureIntent(android.content.Intent captureIntent) Set screen capture permission result. If end user allows the application to capture screen, the application will get screen capture result intent by following Android API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PERMISSION_SCREEN_CAPTURE

public static final int PERMISSION_SCREEN_CAPTURE

Screen capture request code. This code will be used by both widget and application. The widget will use this code to request application screen capture permission according to configuration. Application will use this code to determine if screen capture permission is got, like following code snippet.

 

 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
   if (requestCode == CommunicationFragment.PERMISSION_SCREEN_CAPTURE) {
     CommunicationFragment.setScreenCaptureIntent(data);
   }
 }
 
 

See Also:

Constant Field Values

IS_IN_APP_CALL_RINGING

public static final String IS_IN_APP_CALL_RINGING

If it's the in-app call ringing.

See Also:

Constant Field Values

settings

public static Settings settings

Component UI behavior settings.

contextAttributes

public static ContextAttributes contextAttributes

End user context attribute settings.

service

public static Service service

Service settings.

Constructor Detail

CommunicationFragment

public CommunicationFragment()

Method Detail

setScreenCaptureIntent

public static void setScreenCaptureIntent(android.content.Intent captureIntent)

Set screen capture permission result.
If end user allows the application to capture screen, the application will get screen capture result intent by following Android API.

 
 android.app.Activity.onActivityResult(int requestCode, int resultCode, Intent data)
 
 

The requestCode must equal with CommunicationFragment.PERMISSION_SCREEN_CAPTURE, the widget will use this code to request application screen capture permission according to configuration.

Parameters:

captureIntent - screen capture permission result

newInstance

public static CommunicationFragment newInstance()

Create new CommunicationFragment instance.

Returns:

new created CommunicationFragment instance

setMeetingURL

public static void setMeetingURL(String meetingURL)

Set meeting URL for a meeting call.

Parameters:

meetingURL - the meeting URL

setNotificationContent

public static void setNotificationContent(Map notificationData,
                                          android.content.Context context,
                                          Class cls)

Set in-app call content.

Parameters:

notificationData - the notification data

context - the android application context

cls - the communication fragment parent activity class

setClientInfo

public static void setClientInfo(ClientInfo clientInfo,
                                 android.content.Context context)

Set client information.

Parameters:

clientInfo - the client information

context - the android application context