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

Class UnshareVenueRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<java.lang.String>

com.kontakt.sdk.android.cloud.api.executor.venues.UnshareVenueRequestExecutor

public class UnshareVenueRequestExecutor
extends RequestExecutor<java.lang.String>

Request executor provided by VenuesApi. Use this class if you want to unshare venues through fluent API in chained fashion. Example of use:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.venues().unshare(IDs)
      .fromManagers(managerEmails)
      .execute();
   
 

Keep in mind that managers must be specified so invocation of fromManagers method is mandatory. Otherwise an exception will be thrown at runtime.

Constructor Summary

Constructors

Constructor and Description
UnshareVenueRequestExecutor(VenuesService venuesService, java.util.List<java.util.UUID> ids) Constructs request executor initialized with corresponding service class and venue unique IDs.
UnshareVenueRequestExecutor(VenuesService venuesService, java.util.UUID... ids) Constructs request executor initialized with corresponding service class and venue unique IDs.

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute() Executes created request synchronously.
void	execute(CloudCallback<java.lang.String> callback) Executes created request asynchronously and invokes callback with the result.
UnshareVenueRequestExecutor	fromManagers(java.util.List<java.lang.String> managerEmails) Specifies managers.
UnshareVenueRequestExecutor	fromManagers(java.lang.String... managerEmails) Specifies managers.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's parameters in map.
protected retrofit2.Call<java.lang.String>	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

UnshareVenueRequestExecutor

public UnshareVenueRequestExecutor(VenuesService venuesService,
                                   java.util.UUID... ids)

Constructs request executor initialized with corresponding service class and venue unique IDs.

Parameters:

venuesService - the venues API service.

ids - venue unique identifiers.

UnshareVenueRequestExecutor

public UnshareVenueRequestExecutor(VenuesService venuesService,
                                   java.util.List<java.util.UUID> ids)

Constructs request executor initialized with corresponding service class and venue unique IDs.

Parameters:

venuesService - the venues API service.

ids - venue unique identifiers.

Method Detail

fromManagers

public UnshareVenueRequestExecutor fromManagers(java.lang.String... managerEmails)

Specifies managers. The method invocation is obligatory while using this request executor.

Parameters:

managerEmails - manager email addresses.

Returns:

this request executor.

fromManagers

public UnshareVenueRequestExecutor fromManagers(java.util.List<java.lang.String> managerEmails)

Specifies managers. The method invocation is obligatory while using this request executor.

Parameters:

managerEmails - manager email addresses.

Returns:

this request executor.

execute

public java.lang.String execute()
                         throws java.io.IOException,
                                KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<java.lang.String>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<java.lang.String> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<java.lang.String>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<java.lang.String> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<java.lang.String>

Returns:

the request.

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<java.lang.String>

Returns:

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