com.kontakt.sdk.android.cloud.api

Class VenuesApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.VenuesApi

public class VenuesApi
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
VenuesApi(VenuesService venuesService) Constructs Venues API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
CreateVenueRequestExecutor	create(Venue venue) Provides executor that can be used to create new venue.
DeleteVenueRequestExecutor	delete(java.util.UUID id) Provides executor that can be used to delete a venue.
VenuesRequestExecutor	fetch() Provides executor that can be used to obtain venues.
VenueRequestExecutor	fetch(java.util.UUID id) Provides executor that can be used to obtain single venue by ID.
VenueImageRequestExecutor	imageOf(java.util.UUID id) Provides executor that can be used to load venue's image file.
ShareVenueRequestExecutor	share(java.util.List<java.util.UUID> ids) Provides executor that can be used to share venues with other managers.
ShareVenueRequestExecutor	share(java.util.UUID... ids) Provides executor that can be used to share venues with other managers.
UnshareVenueRequestExecutor	unshare(java.util.List<java.util.UUID> ids) Provides executor that can be used to unshare venues from managers.
UnshareVenueRequestExecutor	unshare(java.util.UUID... ids) Provides executor that can be used to unshare venues from managers.
UpdateVenueRequestExecutor	update(java.util.UUID id) Provides executor that can be used to update a venue.

Methods inherited from class java.lang.Object

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

Constructor Detail

VenuesApi

public VenuesApi(VenuesService venuesService)

Constructs Venues API endpoint initialized with corresponding service class.

Parameters:

venuesService - the venues API service.

Method Detail

fetch

public VenueRequestExecutor fetch(java.util.UUID id)

Provides executor that can be used to obtain single venue by ID.

Parameters:

id - the venue's unique identifier.

Returns:

the request executor.

fetch

public VenuesRequestExecutor fetch()

Provides executor that can be used to obtain venues.

Returns:

the request executor.

imageOf

public VenueImageRequestExecutor imageOf(java.util.UUID id)

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

Parameters:

id - the venue's unique identifier.

Returns:

the request executor.

create

public CreateVenueRequestExecutor create(Venue venue)

Provides executor that can be used to create new venue.

Parameters:

venue - the venue.

Returns:

the request executor.

update

public UpdateVenueRequestExecutor update(java.util.UUID id)

Provides executor that can be used to update a venue.

Parameters:

id - the venue's unique identifier.

Returns:

the request executor.

delete

public DeleteVenueRequestExecutor 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.

share

public ShareVenueRequestExecutor share(java.util.UUID... ids)

Provides executor that can be used to share venues with other managers.

Parameters:

ids - venue unique identifiers.

Returns:

the request executor.

share

public ShareVenueRequestExecutor share(java.util.List<java.util.UUID> ids)

Provides executor that can be used to share venues with other managers.

Parameters:

ids - venue unique identifiers.

Returns:

the request executor.

unshare

public UnshareVenueRequestExecutor unshare(java.util.UUID... ids)

Provides executor that can be used to unshare venues from managers.

Parameters:

ids - venue unique identifiers.

Returns:

the request executor.

unshare

public UnshareVenueRequestExecutor unshare(java.util.List<java.util.UUID> ids)

Provides executor that can be used to unshare venues from managers.

Parameters:

ids - venue unique identifiers.

Returns:

the request executor.