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

Class UpdateVenueRequestExecutor

java.lang.Object

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

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

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

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   // define updated venue object
   kontaktCloud.venues().update(ID)
      .with(updatedVenue)
      .execute();
   
 

Keep in mind that venue must be specified so invocation of with method is mandatory. Otherwise an exception will be thrown.

Constructor Summary

Constructors

Constructor and Description
UpdateVenueRequestExecutor(VenuesService venuesService, java.util.UUID id) Constructs request executor initialized with corresponding service class and venue unique ID.

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.
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.
UpdateVenueRequestExecutor	with(Venue venue) Specifies venue data to update.
UpdateVenueRequestExecutor	withImageFile(byte[] bytes) Specifies new image file.
UpdateVenueRequestExecutor	withImageFile(java.io.File file) Specifies new image file.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateVenueRequestExecutor

public UpdateVenueRequestExecutor(VenuesService venuesService,
                                  java.util.UUID id)

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

Parameters:

venuesService - the venues API service.

id - venue unique identifier.

Method Detail

with

public UpdateVenueRequestExecutor with(Venue venue)

Specifies venue data to update. The method invocation is obligatory while using this request executor.

Parameters:

venue - updated venue data.

Returns:

this request executor.

withImageFile

public UpdateVenueRequestExecutor withImageFile(java.io.File file)
                                         throws java.io.IOException

Specifies new image file.

Parameters:

file - the image file.

Returns:

this request executor.

Throws:

java.io.IOException - instance of IOException

withImageFile

public UpdateVenueRequestExecutor withImageFile(byte[] bytes)
                                         throws java.io.IOException

Specifies new image file.

Parameters:

bytes - the image file as a bytes stream.

Returns:

this request executor.

Throws:

java.io.IOException - instance of IOException

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.