Overview

Add dependency

In the HALO plugin add the following to enable the social sdk.

apply plugin: 'halo'

halo {
    ...
    services {
            auth {
                google "GOOGLE_CLIENT_ID"
                facebook "FACEBOOK_APP_ID"
            }
    }
    ...
}

{% include note.html content="The provider credentials are optional so you may include only the social provider you want to use." %}

Social API

The social API is the way to sign in with social providers on HALO SDK. Importing this library will need a valid HALO instance configured with some credentials and the credentials of the network providers you want to import. The HALO Social SDK allows the user to sign in in three ways:

• HALO username and password.
• Facebook integration. If you want go in deep, please refer to the detailed documentation
• Google plus integration. If you want go in deep, please refer to the detailed documentation

It is fairly recommendable to create the instance as a singleton in your application class or using Dagger after installing HALO. Creating an instance of the Social API is really simple once you have your HALO running. Just write the following lines:

HaloAuthApi authApi = HaloAuthApi.with(haloInstance)
                .recoveryPolicy(HaloAuthApi.RECOVERY_ALWAYS)
                .storeCredentials("halo.account.demoapp")
                .withHalo()
                .withFacebook()
                .withGoogle()
                .build();

Also you have to release the memory in the onTerminate method of your application:

authApi.release();

As you can see there are some parameters that you can provide to configure your social instance. In the following list you will find an explanation for each of those:

Parameter name	Explanation
recoveryPolicy (Optional)	This field specifies if HALO will store your credentials with Android account manager. By default is set to HaloAuthApi.RECOVERY_NEVER so HALO will not store credentials.
storeCredentials (Optional)	This field specifies which is the account type to store on Android account manager. It is mandatory if recoveryPolicy is set to HaloAuthApi.RECOVERY_ALWAYS.
withHalo (Optional)	To use HALO as provider to login or sign in.
withFacebook (Optional)	To use facebook as provider to login.
withGoogle (Optional)	To use google as a provider to login.

Simple use

Login with HALO

Once the instance is created you can login with username and password only if the wihtHalo() was especified on the HaloAuthApi instance. This will try to login the user with this credentials(username,password):

//set a authentication profile to login
HaloAuthProfile authProfile = new HaloAuthProfile(username,password);
//set a callback
CallbackV2<IdentifiedUser> callback = new CallbackV2<IdentifiedUser>() {
        @Override
        public void onFinish(@NonNull HaloResultV2<IdentifiedUser> result) {
            //handle response
        }
    };
//request login with the authoritation profile
authApi.loginWithHalo(HaloAuthApi.SOCIAL_HALO, authProfile, callback);

{% include note.html content="The third parameter is the callback of type CallbackV2<HaloUserProfile> in wich you will handle the result of the authentication query." %}

Login with a social provider (Facebook or Google)

Once the instance is created you can login with social network access token only if the wihtFacebook() or withGoogle() was especified on the HaloAuthApi instance. This will try to login the user after the system obtain the social provider accessToken with the providers:

Note: If you want go in deep on Facebook integration, please refer to the detailed documentation

Note: If you want go in deep on Google integration, please refer to the detailed documentation

If you set withFacebook():

//set a callback
CallbackV2<IdentifiedUser> callback = new CallbackV2<IdentifiedUser>() {
        @Override
        public void onFinish(@NonNull HaloResultV2<IdentifiedUser> result) {
            //handle response
        }
    };
authApi.loginWithSocial(HaloAuthApi.SOCIAL_FACEBOOK, callback);

If you set withGoogle():

//set a callback
CallbackV2<IdentifiedUser> callback = new CallbackV2<IdentifiedUser>() {
        @Override
        public void onFinish(@NonNull HaloResultV2<IdentifiedUser> result) {
            //handle response
        }
    };
authApi.loginWithSocial(HaloAuthApi.SOCIAL_GOOGLE_PLUS, callback);

Note: The second parameter is the callback of type CallbackV2<HaloUserProfile> in wich you will handle the result of the authentication query.

Register

Once the instance is created you can register on HALO providing authoritation object and a user profile only if the withHalo() was especified on the HaloAuthApi instance. This will try to register the user with HALO:

{% include tip.html content="This process only register the user against HALO so you must call to login after registration process finishes correctly." %}

//the authentication profile for the user
HaloAuthProfile authProfile = new HaloAuthProfile(username,password);
//the user profile to register
HaloUserProfile userProfile = new HaloUserProfile(null, displayName, username, password, photoUrl, email);
//make registration with auth profile and user profile given.
authApi.register(authProfile,userProfile)
    .execute(new CallbackV2<HaloUserProfile>() {
        @Override
        public void onFinish(@NonNull HaloResultV2<HaloUserProfile> result) {
            if (result.status().isOk()) { 
                // Handle result
            }
        }
    });

Note: You will handle the result of the registration process with a CallbackV2<HaloUserProfile> as a parameter of execute.

Check a provider

Once the instance is created you can check if a given provider is available. A provider will be available if it was defined when creating the instance and the library of the provider is available.

//the authentication profile for the user
authApi.isAuthProviderAvailable(HaloAuthApi.SOCIAL_HALO);

Release

You could release the memory in the onTerminate method of your application.

//release resources
authApi.release();

Halo Pocket API: Identified user data

With this new HaloPocketAPI you can store two new objects on the identified users collection. One for references ReferenceContainer and one for custom data that can be any model of your business or by default as JSONObject.

• To fetch all Pocket information you should use the get() method.

//get the pocket api instance
HaloPocketApi pocketApi = authApi.pocket();
//get the pocket data (user custom data and filter references)
pocketApi.get().execute(new CallbackV2<Pocket>() {
            @Override
            public void onFinish(@NonNull HaloResultV2<Pocket> result) {
                        
            }
        });

• To store all Pocket information you should use the save(Pocket pocket) method.

//get the pocket api instance
HaloPocketApi pocketApi = authApi.pocket();
//create a pocket instance
Pocket pocket = new Pocket.Builder()
                .withData(customModelClass)
                .withReferences(referenceContainer)
                .build();
//get the pocket data (user custom data and filter references)
pocketApi.save(pocket).execute(new CallbackV2<Pocket>() {
            @Override
            public void onFinish(@NonNull HaloResultV2<Pocket> result) {
                        
            }
        });

Warning: If you want go in deep, please refer to the detailed documentation