undefined

Authentication and Users

Every user needs to authenticate with ConnectyCube before using any ConnectyCube functionality.

When someone connects with an application using ConnectyCube, the application will need to obtain a session token which provides temporary secure access to ConnectyCube APIs.

A session token is an opaque string that identifies a user and an application.

Session token rights

There are different types of session tokens to support different use cases:

Session Token Type Description
Application session token This kind of access token is needed to read the app data. Has only READ access to resources
User session token The user token is the most commonly used type of token. This kind of access token is needed any time the app calls an API to read, modify or write a specific user's data on their behalf. Has READ/WRITE access to resources

Session token management

Android SDK supports automatic session management, so you do not need to create a session token on Android manually:

  • on your 1st request to API the session token will be created automatically
  • when the session expires, any further API request will renew it.

You can track session states using ConnectyCubeSessionManager class and SessionListener listener:

ConnectycubeSessionManager.getInstance().addListener(new ConnectycubeSessionManager.SessionListener() {
   @Override
   public void onSessionCreated(ConnectycubeSession session) {

   }

   @Override
   public void onSessionUpdated(ConnectycubeSessionParameters sessionParameters) {

   }

   @Override
   public void onSessionDeleted() {

   }

   @Override
   public void onSessionRestored(ConnectycubeSession session) {

   }

   @Override
   public void onSessionExpired() {

   }

   @Override
   public void onProviderSessionExpired(String provider) {

   }
});

Session token details

At any time you can get details about your current session token:

ConnectycubeSessionParameters sessionParameters = ConnectycubeSessionManager.getInstance().getSessionParameters();
sessionParameters.getUserId();
sessionParameters.getUserLogin();
sessionParameters.getUserEmail();
sessionParameters.getSocialProvider();
sessionParameters.getAccessToken();

Also you can check whether you are logged in or not:

boolean isSignedIn = ConnectycubeSessionManager.getInstance().getSessionParameters() != null;

Upgrade session token (user login)

If you have an application session, you can upgrade it to a user session by calling signIn method:

final ConnectycubeUser user = new ConnectycubeUser();
user.setLogin("marvin18");
user.setPassword("supersecurepwd");

ConnectycubeUsers.signIn(user).performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser user, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Authentication via phone number

Sign In with phone number is supported with Firebase integration.

The whole guide on how to create Firebase project, connect Firebase SDK and implement authentication via phone number is available at our Firebase Setup Guide. Please follow it.

Downgrade session token (user logout)

If you have a user session, you can downgrade it to an application session by calling signOut method:

ConnectycubeUsers.signOut().performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});

Session expiration

Expiration time for session token is 2 hours after the last request to API is made. But you do not need to worry about it - with the automatic session token management it will be renewed automatically with next request to API.

Destroy session token

To destroy a session use the following code:

ConnectycubeAuth.deleteSession().performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});

User signup

final ConnectycubeUser user = new ConnectycubeUser("marvin18", "supersecurepwd");
user.setLogin("marvin18");
user.setPassword("supersecurepwd");
user.setEmail("awesomeman@gmail.com");
user.setFullName("Marvin Simon");
user.setPhone("47802323143");
user.setWebsite("https://dozensofdreams.com");
StringifyArrayList<String> tags = new StringifyArrayList<String>();
tags.add("iphone");
tags.add("apple");
user.setTags(tags);

ConnectycubeUsers.signUp(user).performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser user, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Only login (or email) + password are required. Other fields are optional.

User profile update

ConnectycubeUser user = new ConnectycubeUser();
user.setLogin("marvin18");
user.setFullName("Marvin Simon");

ConnectycubeUsers.update(user).performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser user, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

If you want to change your password, you need to provide 2 parameters: password and oldPassword. An updated user entity will be returned.

User avatar

You can set a user's avatar. You just need to upload it to the ConnectyCube cloud storage and then connect to user.

File imageFile = ...
ConnectycubeStorage.uploadFileTask(imageFile, false, null).performAsync(new EntityCallback<ConnectycubeFile>() {
    @Override
    public void onSuccess(ConnectycubeFile connectycubeFile, Bundle params) {
        JsonObject jo = new JsonObject();
        jo.add("avatar_uid", new JsonPrimitive(connectycubeFile.getUid()));
        user.setCustomData(jo.toString());

        ConnectycubeUsers.updateUser(user).performAsync(...);
    }

    @Override
    public void onError(ResponseException responseException) {

    }
});

Now, other users can get you avatar:

JsonObject obj = new JsonParser().parse(user.getCustomData()).getAsJsonObject();
String fileUID = obj.getAsJsonPrimitive("avatar_uid").getAsString();
String avatarUrl = ConnectycubeFile.getPrivateUrlForUID(fileUID);

Password reset

It's possible to reset a password via email:

ConnectycubeUsers.resetPassword("awesomeman@gmail.com").performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});

Retrieve users

Retrieve users by ID

PagedRequestBuilder pagedRequestBuilder = new PagedRequestBuilder();
pagedRequestBuilder.setPage(1);
pagedRequestBuilder.setPerPage(50);

List<Integer> usersIds = new ArrayList<>();
usersIds.add(22);
usersIds.add(23);

Bundle params = new Bundle();

ConnectycubeUsers.getUsersByIDs(usersIds, pagedRequestBuilder, params).performAsync(new EntityCallback<ArrayList<ConnectycubeUser>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeUser> users, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve user by login

ConnectycubeUsers.getUserByLogin("amigo").performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser user, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve user by email

ConnectycubeUsers.getUserByEmail("amigo@gmail.com").performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser user, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve users by full name

PagedRequestBuilder pagedRequestBuilder = new PagedRequestBuilder();
pagedRequestBuilder.setPage(1);
pagedRequestBuilder.setPerPage(50);

Bundle params = new Bundle();

ConnectycubeUsers.getUsersByFullName("Marvin Samuel", pagedRequestBuilder, params).performAsync(new EntityCallback<ArrayList<ConnectycubeUser>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeUser> users, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve user by phone number

PagedRequestBuilder pagedRequestBuilder = new PagedRequestBuilder();
pagedRequestBuilder.setPage(1);
pagedRequestBuilder.setPerPage(50);

Bundle params = new Bundle();

ArrayList<String> usersPhones = new ArrayList<>();
usersPhones.add("+4427123314");

ConnectycubeUsers.getUsersByPhoneNumbers(usersPhones, pagedRequestBuilder, params).performAsync(new EntityCallback<ArrayList<ConnectycubeUser>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeUser> users, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve user by external ID

ConnectycubeUsers.getUserByExternalId(3789).performAsync(new EntityCallback<ConnectycubeUser>() {
    @Override
    public void onSuccess(ConnectycubeUser users, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Retrieve users by tags

PagedRequestBuilder pagedRequestBuilder = new PagedRequestBuilder();
pagedRequestBuilder.setPage(1);
pagedRequestBuilder.setPerPage(50);

ArrayList<String> userTags = new ArrayList<>();
userTags.add("iphone");

Bundle params = new Bundle();

ConnectycubeUsers.getUsersByTags(userTags, pagedRequestBuilder, params).performAsync(new EntityCallback<ArrayList<ConnectycubeUser>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeUser> users, Bundle args) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});

Delete user

A user can delete himself from the platform:

ConnectycubeUsers.deleteUser().performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});