com.kontakt.sdk.android.cloud.api.executor.managers

Class CreateManagerRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<Manager>

com.kontakt.sdk.android.cloud.api.executor.managers.CreateManagerRequestExecutor

public class CreateManagerRequestExecutor
extends RequestExecutor<Manager>

Request executor provided by ManagersApi. Use this class if you want to create managers through fluent API in chained fashion, for instance:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Manager manager = new Manager.Builder()
      .firstName("Superb")
      .lastName("Kontakter")
      .email("superb.kontakter@kontakt.io")
      .role(Manager.Role.SUPERUSER)
      .build();
   kontaktCloud.managers().create(manager).execute();
   
 

Keep in mind that new manager instance that we want to create must have initialized the following fields: first name, last name, email address and role. Otherwise an exception will be thrown.

Constructor Summary

Constructors

Constructor and Description
CreateManagerRequestExecutor(ManagersService managersService, Manager manager) Constructs request executor initialized with corresponding service class and manager object.

Method Summary

Modifier and Type	Method and Description
Manager	execute() Executes created request synchronously.
void	execute(CloudCallback<Manager> callback) Executes created request asynchronously and invokes callback with the result.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's parameters in map.
protected retrofit2.Call<Manager>	prepareCall() Prepares a request to execute.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateManagerRequestExecutor

public CreateManagerRequestExecutor(ManagersService managersService,
                                    Manager manager)

Constructs request executor initialized with corresponding service class and manager object.

Parameters:

managersService - the managers API service.

manager - the manager entity.

Method Detail

prepareCall

protected retrofit2.Call<Manager> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Manager>

Returns:

the request.

execute

public Manager execute()
                throws java.io.IOException,
                       KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Manager>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Manager> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Manager>

Parameters:

callback - the callback object.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Composes the request's parameters in map.

Specified by:

params in class RequestExecutor<Manager>

Returns:

the map of request body parameters that are being used to update data on server.