How To

For full documentation please refer to the appropriate SDK.
iOS DocumentationAndroid DocumentationServer Callback Documentation

Requirements

  • iOS
  • Operating System

    Requires iOS 7.0 and later

  • User Management

    Messaging and compliance applications require your app to include the concept of uniquely-identifiable users. These can be managed using your own servers, using a third-party user management mBaaS (mobile backend as a service), or unique social identifiers via services like Facebook or Twitter.

    Other types of apps using the service do not necessarily require identifiable users.

  • Android
  • Operating System

    Requires Andrid OS 4.1 and later

  • User Management

    Messaging and compliance applications require your app to include the concept of uniquely-identifiable users. These can be managed using your own servers, using a third-party user management mBaaS (mobile backend as a service), or unique social identifiers via services like Facebook or Twitter.

    Other types of apps using the service do not necessarily require identifiable users.

Get the SDK

  • iOS
  • Manual Integration

    Pull the repository from GitHub: https://github.com/Aclipsa/messaging-sdk-ios

    Import the SDK into your project

  • Use a Dependency Manager

    Use Cocoapods and add the following to your podfile:
    pod 'AclipsaSDK'

  • Android
  • Manual Integration

    Pull the repository from GitHub: https://github.com/Aclipsa/messaging-sdk-android

    Copy the aclipsasdk.jar and common.jar into the libs folder of your project

  • Use a Dependency Manager

    Make sure repositories is set to jcenter in your build.gradle .

    repositories { jcenter() }

Setup

  • iOS
  • On application start, or the first time the app is going to use the SDK features, create a new Aclipsa Session using ACLIPSesssion with the app's assigned API Key.

    For user-specific actions, provide a user ID.

  • Android
  • On application start, or the first time the app is going to use the SDK features, create a new Aclipsa Session using ACLIPSesssion with the app's assigned API Key.

    For user-specific actions, provide a user ID.

Manage Users

  • iOS
  • If your app has uniquely-identifiable users you can manage Aclipsa's knowledge of them by providing one or more user IDs when sending a video or message. Use deleteUserWithID to remove a user ID from the system.

  • Android
  • If your app has uniquely-identifiable users you can manage Aclipsa's knowledge of them by providing one or more user IDs when sending a video or message. Use deleteUserWithID to remove a user ID from the system.

Create a Video

  • iOS
  • Record a New Video

    Use a UIImagePickerController

  • Select a Local Video

    Use AVCaptureSession

  • Android
  • Record a New Video

    Use MediaStore ACTION_VIDEO_CAPTURE

  • Select a Local Video

    Use the Intent.ACTION_GET_CONTENT intent

Sending

  • iOS
  • Send a Video

    Use one of the uploadVideo methods. Optionally provide one or more values for the "attributes" parameter to apply custom filters that indicate which uploaded videos a user can view.

  • Send a Message

    Set the recipients, message text (if any), and the associated video ID (if any). Send using one of the sendMessage methods.

    Messages can be "yanked" (recalled, no recipients can view the message) and "unyanked" (un-recalled, recipients can once again view the message).

  • Displaying

    Because videos can be deleted or recalled, we recommended you reload a video before attempting to play it to ensure it is still available to the user.

  • Retrieve Videos or Messages

    Load all or filter using an NSPredicate

  • Display a Video for Playing

    Use moviePlayerControllerForVideo

  • Android
  • Send a Video

    Use one of the uploadVideo methods. Optionally provide one or more values for the "attributes" parameter to apply custom filters that indicate which uploaded videos a user can view.

  • Send a Message

    Set the recipients, message text (if any), and the associated video ID (if any). Send using one of the sendMessage methods.

    Messages can be "yanked" (recalled, no recipients can view the message) and "unyanked" (un-recalled, recipients can once again view the message).

  • Displaying

    Because videos can be deleted or recalled, we recommended you reload a video before attempting to play it to ensure it is still available to the user.

  • Retrieve Videos or Messages

    Load all or filter using Enum AclipsaSDKConstants.MESSAGE_FILTER

Server Integration

  • iOS
  • If you want your server to be notified of certain Aclipsa events such as the completion of video processing (so that, for example, you can send push notifications to your users), you'll need to setup a server callback.

    In the Developer Portal in the App Information section, set your URL.

  • Android
  • If you want your server to be notified of certain Aclipsa events such as the completion of video processing (so that, for example, you can send push notifications to your users), you'll need to setup a server callback.

    In the Developer Portal in the App Information section, set your URL.