C# Class Hyves.Service.ListenersService

Represents the service APIs that allow access to information on Hyves listener (Who What Where).
ファイルを表示 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method Description
CreateListener ( HyvesListenerType type, string callback ) : Listener

Create a new listener for the ApiConsumer. This corresponds to the listener.create Hyves method.
DeleteListener ( string listenerId ) : bool

Deletes a listener for the ApiConsumer. This corresponds to the listener.create Hyves method.
GetAllListeners ( ) : Collection

Gets the desired listeners from the specified type. This corresponds to the listeners.getAll Hyves method.
GetListener ( string listenerId ) : Listener

Gets the desired information about the specified listener. This corresponds to the listeners.get Hyves method.
GetListeners ( Collection listenerIds ) : Collection

Gets the desired information about the specified listener. This corresponds to the listeners.get Hyves method.
GetListenersByType ( HyvesListenerType type ) : Collection

Gets the desired listeners from the specified type. This corresponds to the listeners.getByType Hyves method.

Private Methods

Method Description
ListenersService ( HyvesSession session ) : System

Method Details

CreateListener() public method

Create a new listener for the ApiConsumer. This corresponds to the listener.create Hyves method.
public CreateListener ( HyvesListenerType type, string callback ) : Listener
type HyvesListenerType Type of listener to create.
callback string Url to do the callback to.
return Listener

DeleteListener() public method

Deletes a listener for the ApiConsumer. This corresponds to the listener.create Hyves method.
public DeleteListener ( string listenerId ) : bool
listenerId string The requested listenerId.
return bool

GetAllListeners() public method

Gets the desired listeners from the specified type. This corresponds to the listeners.getAll Hyves method.
public GetAllListeners ( ) : Collection
return Collection

GetListener() public method

Gets the desired information about the specified listener. This corresponds to the listeners.get Hyves method.
public GetListener ( string listenerId ) : Listener
listenerId string The requested listenerId.
return Listener

GetListeners() public method

Gets the desired information about the specified listener. This corresponds to the listeners.get Hyves method.
public GetListeners ( Collection listenerIds ) : Collection
listenerIds Collection
return Collection

GetListenersByType() public method

Gets the desired listeners from the specified type. This corresponds to the listeners.getByType Hyves method.
public GetListenersByType ( HyvesListenerType type ) : Collection
type HyvesListenerType Type of listeners to retrieve.
return Collection