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

Class CreateVenueRequestExecutor

java.lang.Object

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

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

public class CreateVenueRequestExecutor
extends RequestExecutor<Venue>

Request executor provided by VenuesApi. Use this class if you want to create venues through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Venue venue = new Venue.Builder()
      .name("Kontakt.io office")
      .description("Beacon valley")
      .build();
   kontaktCloud.venues().create(venue)
      .withImageFile(new File(fileName))
      .execute();
   
 

Keep in mind that new venue instance that we want to create must have initialized name and description fields. Otherwise an exception will be thrown.

Constructor Summary

Constructors

Constructor and Description
CreateVenueRequestExecutor(VenuesService venuesService, Venue venue) Constructs request executor initialized with corresponding service class and venue object.

Method Summary

Modifier and Type	Method and Description
Venue	execute() Executes created request synchronously.
void	execute(CloudCallback<Venue> 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<Venue>	prepareCall() Prepares a request to execute.
CreateVenueRequestExecutor	withImageFile(byte[] bytes) Specifies an image file of newly created venue.
CreateVenueRequestExecutor	withImageFile(java.io.File file) Specifies an image file of newly created venue.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateVenueRequestExecutor

public CreateVenueRequestExecutor(VenuesService venuesService,
                                  Venue venue)

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

Parameters:

venuesService - the venues API service.

venue - the venue entity.

Method Detail

withImageFile

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

Specifies an image file of newly created venue.

Parameters:

file - the image file.

Returns:

this request executor.

Throws:

java.io.IOException - instance of exception

withImageFile

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

Specifies an image file of newly created venue.

Parameters:

bytes - the image file as a bytes stream.

Returns:

this request executor.

Throws:

java.io.IOException - instance of IOException

execute

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

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Venue>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Venue> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Venue>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<Venue> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Venue>

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<Venue>

Returns:

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