com.kontakt.sdk.android.cloud.api

Class PlacesApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.PlacesApi

public class PlacesApi
extends java.lang.Object

An abstract representation of Place API endpoint. Provides executors that can be used to handle all place-related requests.

Constructor Summary

Constructors

Constructor and Description
PlacesApi(PlacesService placesService) Constructs Place API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
CreatePlaceRequestExecutor	create(Place place) Provides executor that can be used to create new place.
DeletePlaceRequestExecutor	delete(java.util.UUID id) Provides executor that can be used to delete a venue.
PlacesRequestExecutor	fetch() Provides executor that can be used to obtain places.
PlaceSchemaImageRequestExecutor	schemaImageOf(java.util.UUID id) Provides executor that can be used to load place's schema image file.
UpdatePlaceRequestExecutor	update(java.util.UUID id) Provides executor that can be used to update a place.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlacesApi

public PlacesApi(PlacesService placesService)

Constructs Place API endpoint initialized with corresponding service class.

Parameters:

placesService - the places API service.

Method Detail

fetch

public PlacesRequestExecutor fetch()

Provides executor that can be used to obtain places.

Returns:

the request executor.

schemaImageOf

public PlaceSchemaImageRequestExecutor schemaImageOf(java.util.UUID id)

Provides executor that can be used to load place's schema image file.

Parameters:

id - the place's identifier

Returns:

the request executor.

create

public CreatePlaceRequestExecutor create(Place place)

Provides executor that can be used to create new place.

Parameters:

place - the place.

Returns:

the request executor.

update

public UpdatePlaceRequestExecutor update(java.util.UUID id)

Provides executor that can be used to update a place.

Parameters:

id - the place's identifier.

Returns:

the request executor.

delete

public DeletePlaceRequestExecutor delete(java.util.UUID id)

Provides executor that can be used to delete a venue.

Parameters:

id - the venue's unique identifier.

Returns:

the request executor.