C# Class Hyves.Service.PingsService

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

Datei anzeigen Open project: Sitecore/Hyves-network-provider-for-Sitecore-Social-Connected-1.3

Public Methods

Method	Description
CreatePing ( string targetUserId, string pingTypeId, string body, HyvesVisibility visibility ) : Ping	Creates a ping. This corresponds to the pings.create Hyves method.
CreatePingByFriend ( string targetUserId, string pingTypeId, string body, HyvesVisibility visibility ) : Ping	Creates a ping. This corresponds to the pings.createByFriend Hyves method. Hidden method (for any partner).
GetPing ( string pingId ) : Ping	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPing ( string pingId, HyvesPingResponsefield responsefields ) : Ping	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPing ( string pingId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Ping	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPing ( string pingId, bool useFancyLayout ) : Ping	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPingTypes ( ) : Collection	Gets the default ping types. This corresponds to the pings.getTypes Hyves method. Hidden method (for any partner).
GetPings ( Collection pingIds ) : Collection	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPings ( Collection pingIds, HyvesPingResponsefield responsefields ) : Collection	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPings ( Collection pingIds, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPings ( Collection pingIds, bool useFancyLayout ) : Collection	Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.
GetPingsByTargetUser ( string userId ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.
GetPingsByTargetUser ( string userId, HyvesPingResponsefield responsefields ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.
GetPingsByTargetUser ( string userId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.
GetPingsByTargetUser ( string userId, bool useFancyLayout ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.
GetPingsByUser ( string userId ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByUser Hyves method.
GetPingsByUser ( string userId, HyvesPingResponsefield responsefields ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByUser Hyves method.
GetPingsByUser ( string userId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByUser Hyves method.
GetPingsByUser ( string userId, bool useFancyLayout ) : Collection	Gets the desired pings from the specified user. This corresponds to the pings.getByUser Hyves method.

Private Methods

Method	Description
ConvertResponsefieldsToString ( HyvesPingResponsefield responsefields ) : string
PingsService ( HyvesSession session ) : System

Method Details

CreatePing() public method

Creates a ping. This corresponds to the pings.create Hyves method.

public CreatePing ( string targetUserId, string pingTypeId, string body, HyvesVisibility visibility ) : Ping
targetUserId	string	The title of the ping.
pingTypeId	string
body	string	The body of the ping.
visibility	HyvesVisibility	The visibility of the ping.
return	Ping

CreatePingByFriend() public method

Creates a ping. This corresponds to the pings.createByFriend Hyves method.

Hidden method (for any partner).

public CreatePingByFriend ( string targetUserId, string pingTypeId, string body, HyvesVisibility visibility ) : Ping
targetUserId	string	The title of the ping.
pingTypeId	string	The identifier for a ping type.
body	string	The html of the ping.
visibility	HyvesVisibility	The visibility of the ping.
return	Ping

GetPing() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPing ( string pingId ) : Ping
pingId	string	The requested pingId.
return	Ping

GetPing() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPing ( string pingId, HyvesPingResponsefield responsefields ) : Ping
pingId	string	The requested pingId.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
return	Ping

GetPing() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPing ( string pingId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Ping
pingId	string	The requested pingId.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Ping

GetPing() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPing ( string pingId, bool useFancyLayout ) : Ping
pingId	string	The requested pingId.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Ping

GetPingTypes() public method

Gets the default ping types. This corresponds to the pings.getTypes Hyves method.

Hidden method (for any partner).

public GetPingTypes ( ) : Collection
return	Collection

GetPings() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPings ( Collection pingIds ) : Collection
pingIds	Collection	The requested pingIds.
return	Collection

GetPings() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPings ( Collection pingIds, HyvesPingResponsefield responsefields ) : Collection
pingIds	Collection	The requested pingIds.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
return	Collection

GetPings() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPings ( Collection pingIds, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection
pingIds	Collection	The requested pingIds.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetPings() public method

Gets the desired information about the specified ping. This corresponds to the pings.get Hyves method.

public GetPings ( Collection pingIds, bool useFancyLayout ) : Collection
pingIds	Collection	The requested pingIds.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetPingsByTargetUser() public method

Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.

public GetPingsByTargetUser ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetPingsByTargetUser() public method

Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.

public GetPingsByTargetUser ( string userId, HyvesPingResponsefield responsefields ) : Collection
userId	string	The requested user Id.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
return	Collection

GetPingsByTargetUser() public method

Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.

public GetPingsByTargetUser ( string userId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetPingsByTargetUser() public method

Gets the desired pings from the specified user. This corresponds to the pings.getByTargetUser Hyves method.

public GetPingsByTargetUser ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetPingsByUser() public method

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

public GetPingsByUser ( string userId ) : Collection
userId	string	The requested user Id.
return	Collection

GetPingsByUser() public method

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

public GetPingsByUser ( string userId, HyvesPingResponsefield responsefields ) : Collection
userId	string	The requested user Id.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
return	Collection

GetPingsByUser() public method

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

public GetPingsByUser ( string userId, HyvesPingResponsefield responsefields, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
responsefields	HyvesPingResponsefield	Get extra information from the ping.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection

GetPingsByUser() public method

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

public GetPingsByUser ( string userId, bool useFancyLayout ) : Collection
userId	string	The requested user Id.
useFancyLayout	bool	Display information the same way that that is being done on the site, including things like smilies.
return	Collection