C# Class Hyves.Service.EventsService

Represents the service APIs that allow access to information on Hyves event.

显示文件 Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
AddPresence ( string eventId, HyvesEventPrecenseVisibility visibility ) : bool	Adds user presence to event. This corresponds to the event.addPresence Hyves method.
GetEvents ( Collection eventIds ) : Collection	Gets the desired information about the specified event. This corresponds to the events.get Hyves method.
GetEvents ( Collection eventIds, HyvesEventResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified event. This corresponds to the events.get Hyves method.
GetEventsByHub ( string hubId, bool inFuture, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired events from the specified hub. This corresponds to the events.getByHub Hyves method.
GetEventsByLoggedin ( bool inFuture, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired events from the loggedin user. This corresponds to the events.getByLoggedin Hyves method.
GetEventsByUserPresent ( string userId, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection	Gets the desired events from the specified user. This corresponds to the events.getByUser Hyves method.
GetPresence ( string eventId ) : Collection	Gets the desired information about the presence. This corresponds to the events.getPresence Hyves method.
GetPresenceForFriends ( string eventId ) : Collection	Gets the desired information about the presence. This corresponds to the events.getPresenceForFriends Hyves method.

Private Methods

Method	Description
ConvertResponsefieldsToString ( HyvesEventResponsefield responsefields ) : string
EventsService ( HyvesSession session ) : System

Method Details

AddPresence() public method

Adds user presence to event. This corresponds to the event.addPresence Hyves method.

public AddPresence ( string eventId, HyvesEventPrecenseVisibility visibility ) : bool
eventId	string	The identifier of the event.
visibility	HyvesEventPrecenseVisibility	The visibility of the event presence.
return	bool

GetEvents() public method

Gets the desired information about the specified event. This corresponds to the events.get Hyves method.

public GetEvents ( Collection eventIds ) : Collection
eventIds	Collection	The requested eventIds.
return	Collection

GetEvents() public method

Gets the desired information about the specified event. This corresponds to the events.get Hyves method.

public GetEvents ( Collection eventIds, HyvesEventResponsefield responsefields, bool useFancyLayout ) : Collection
eventIds	Collection	The requested eventIds.
responsefields	HyvesEventResponsefield	Get extra information from the requested event.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetEventsByHub() public method

Gets the desired events from the specified hub. This corresponds to the events.getByHub Hyves method.

public GetEventsByHub ( string hubId, bool inFuture, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
hubId	string	The requested hub Id.
inFuture	bool	Select only events in the future.
responsefields	HyvesEventResponsefield	Get extra information from the requested event.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetEventsByLoggedin() public method

Gets the desired events from the loggedin user. This corresponds to the events.getByLoggedin Hyves method.

public GetEventsByLoggedin ( bool inFuture, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
inFuture	bool	Select only events in the future.
responsefields	HyvesEventResponsefield	Get extra information from the requested event.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetEventsByUserPresent() public method

Gets the desired events from the specified user. This corresponds to the events.getByUser Hyves method.

public GetEventsByUserPresent ( string userId, HyvesEventResponsefield responsefields, bool useFancyLayout, int page, int resultsPerPage ) : Collection
userId	string	The requested user Id.
responsefields	HyvesEventResponsefield	Get extra information from the requested event.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
page	int	The requested page.
resultsPerPage	int	The number of results per page.
return	Collection

GetPresence() public method

Gets the desired information about the presence. This corresponds to the events.getPresence Hyves method.

public GetPresence ( string eventId ) : Collection
eventId	string
return	Collection

GetPresenceForFriends() public method

Gets the desired information about the presence. This corresponds to the events.getPresenceForFriends Hyves method.

public GetPresenceForFriends ( string eventId ) : Collection
eventId	string
return	Collection