com.kontakt.sdk.android.cloud.api

Class ReceiversApi

java.lang.Object

com.kontakt.sdk.android.cloud.api.ReceiversApi

public class ReceiversApi
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
ReceiversApi(ReceiversService receiversService) Constructs Receiver API endpoint initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
CreateReceiverRequestExecutor	create(Receiver receiver) Provides executor that can be used to create new receiver.
DeleteReceiverRequestExecutor	delete(java.util.UUID id) Provides executor that can be used to delete a receiver.
ReceiversRequestExecutor	fetch() Provides executor that can be used to obtain receivers.
UpdateReceiverRequestExecutor	update(java.util.UUID id) Provides executor that can be used to update a receiver.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiversApi

public ReceiversApi(ReceiversService receiversService)

Constructs Receiver API endpoint initialized with corresponding service class.

Parameters:

receiversService - the receivers API service.

Method Detail

fetch

public ReceiversRequestExecutor fetch()

Provides executor that can be used to obtain receivers.

Returns:

the request executor.

create

public CreateReceiverRequestExecutor create(Receiver receiver)

Provides executor that can be used to create new receiver.

Parameters:

receiver - the receiver.

Returns:

the request executor.

update

public UpdateReceiverRequestExecutor update(java.util.UUID id)

Provides executor that can be used to update a receiver.

Parameters:

id - the receiver's identifier

Returns:

the request executor.

delete

public DeleteReceiverRequestExecutor delete(java.util.UUID id)

Provides executor that can be used to delete a receiver.

Parameters:

id - the receiver's identifier.

Returns:

the request executor.