com.kontakt.sdk.android.http.interfaces

Interface VenuesApiAccessor

All Known Subinterfaces:

IKontaktApiClient

All Known Implementing Classes:

KontaktApiClient

public interface VenuesApiAccessor

Venues API Accessor provides interface describing Venues management.

Method Summary

Modifier and Type	Method and Description
HttpResult<IVenue>	createVenue(VenueData venue) Creates venue.
void	createVenue(VenueData venueData, ResultApiCallback<IVenue> apiCallback) Create venue.
int	deleteVenue(java.util.UUID venueId) Deletes venue.
void	deleteVenue(java.util.UUID venueId, UpdateApiCallback apiCallback) Delete venue.
HttpResult<IVenue>	getVenue(java.util.UUID venueId, SDKOptional<ETag> eTag) Requests venue by venue Id.
void	getVenue(java.util.UUID venueId, SDKOptional<ETag> etag, ResultApiCallback<IVenue> apiCallback) Gets venue.
HttpResult<FileData>	getVenueImage(java.util.UUID venueId) Requests venue image by venue Id.
void	getVenueImage(java.util.UUID venueId, ResultApiCallback<FileData> apiCallback) Gets venue image.
HttpResult<java.util.List<IVenue>>	listVenues() List venues.
HttpResult<java.util.List<IVenue>>	listVenues(RequestDescription requestDescription) Provides the list of venues.
void	listVenues(RequestDescription requestDescription, ResultApiCallback<java.util.List<IVenue>> apiCallback) List venues.
void	listVenues(ResultApiCallback<java.util.List<IVenue>> apiCallback) List venues.
int	updateVenue(VenueData venueData) Updates venue.
void	updateVenue(VenueData venueData, UpdateApiCallback apiCallback) Update venue.

Methods inherited from interface java.io.Closeable

close

Method Detail

updateVenue

int updateVenue(VenueData venueData)
         throws ClientException

Updates venue. Required parameter: venue Id. The optional parameters are: Venue Id, name, file, description. If any of the optional values is null, it will not be updated.

Parameters:

venueData - the venue update data

Returns:

the int

Throws:

ClientException - if update fails

updateVenue

void updateVenue(VenueData venueData,
                 UpdateApiCallback apiCallback)

Update venue.

Parameters:

venueData - the venue data

apiCallback - the api callback

createVenue

HttpResult<IVenue> createVenue(VenueData venue)
                        throws ClientException

Creates venue. Required parameter: name. The optional parameters are: fileData, description. If any of the optional parameters is null, it will not be updated.

Parameters:

venue - the venue

Returns:

the result

Throws:

ClientException - is thrown if unexpected error has occured

createVenue

void createVenue(VenueData venueData,
                 ResultApiCallback<IVenue> apiCallback)

Create venue.

Parameters:

venueData - the venue data

apiCallback - the api callback

getVenue

HttpResult<IVenue> getVenue(java.util.UUID venueId,
                            SDKOptional<ETag> eTag)
                     throws ClientException

Requests venue by venue Id. If the ETag's value matches the latest one the code 304 (NOT MODIFIED) is returned. Otherwise the method behaves identically as getVenueImage(UUID)

Parameters:

venueId - the venue id

eTag - the e tag

Returns:

the venue

Throws:

ClientException - is thrown if unexpected error has occured

getVenue

void getVenue(java.util.UUID venueId,
              SDKOptional<ETag> etag,
              ResultApiCallback<IVenue> apiCallback)

Gets venue.

Parameters:

venueId - the venue id

etag - the etag

apiCallback - the api callback

deleteVenue

int deleteVenue(java.util.UUID venueId)
         throws ClientException

Deletes venue.

Parameters:

venueId - the venue Id

Returns:

the Http Status. Successful deletion status is 200.

Throws:

ClientException - is thrown if unexpected error has occured

deleteVenue

void deleteVenue(java.util.UUID venueId,
                 UpdateApiCallback apiCallback)

Delete venue.

Parameters:

venueId - the venue id

apiCallback - the api callback

getVenueImage

HttpResult<FileData> getVenueImage(java.util.UUID venueId)
                            throws ClientException

Requests venue image by venue Id.

Parameters:

venueId - the venue id

Returns:

the venue image

Throws:

ClientException - is thrown if unexpected error has occured

getVenueImage

void getVenueImage(java.util.UUID venueId,
                   ResultApiCallback<FileData> apiCallback)

Gets venue image.

Parameters:

venueId - the venue id

apiCallback - the api callback

listVenues

HttpResult<java.util.List<IVenue>> listVenues(RequestDescription requestDescription)
                                       throws ClientException

Provides the list of venues. According to request description the response:

• may contain sorted list items
• may contain empty body for conditional requests with ETag value included in headers
• may contain list items in ascending or descending order
• may contain ranged list items by specifying start index and offset

Parameters:

requestDescription - the request description

Returns:

the devices

Throws:

ClientException - the client exception

listVenues

HttpResult<java.util.List<IVenue>> listVenues()
                                       throws ClientException

List venues.

Returns:

the http result

Throws:

ClientException - the client exception

listVenues

void listVenues(RequestDescription requestDescription,
                ResultApiCallback<java.util.List<IVenue>> apiCallback)

List venues.

Parameters:

requestDescription - the request description

apiCallback - the api callback

listVenues

void listVenues(ResultApiCallback<java.util.List<IVenue>> apiCallback)

List venues.

Parameters:

apiCallback - the api callback