C# Class HipchatApiV2.HipchatClient

Afficher le fichier Open project: KyleGobel/Hipchat-CS Class Usage Examples

Méthodes publiques

Méthode	Description
AddMember ( string roomName, string idOrEmail ) : bool
CreateRoom ( CreateRoomRequest request ) : HipchatCreateRoomResponse
CreateRoom ( string nameOfRoom, bool guestAccess = false, string ownerUserId = null, RoomPrivacy privacy = RoomPrivacy.Public ) : HipchatCreateRoomResponse
CreateUser ( CreateUserRequest request ) : HipchatCreateUserResponse
CreateWebHook ( int roomId, string url, string pattern, Hipchat.Models.RoomEvent eventType, string name ) : CreateWebHookResponse
CreateWebHook ( string roomName, Hipchat.Models.Requests.CreateWebHookRequest request ) : CreateWebHookResponse
CreateWebHook ( string roomName, string url, string pattern, Hipchat.Models.RoomEvent eventType, string name ) : CreateWebHookResponse
DeleteRoom ( int roomId ) : bool
DeleteRoom ( string roomName ) : bool
DeleteUser ( string idOrEmail ) : bool
DeleteWebhook ( int roomId, int webHookId ) : bool
DeleteWebhook ( string roomName, int webHookId ) : bool
GenerateToken ( GrantType grantType, IEnumerable scopes, string username = null, string code = null, string redirectUri = null, string password = null, string refreshToken = null ) : HipchatGenerateTokenResponse
GetAllEmoticons ( int startIndex, int maxResults = 100, EmoticonType type = EmoticonType.All ) : HipchatGetAllEmoticonsResponse
GetAllRooms ( int startIndex, int maxResults = 100, bool includePrivate = false, bool includeArchived = false ) : HipchatGetAllRoomsResponse
GetAllUsers ( int startIndex, int maxResults = 100, bool includeGuests = false, bool includeDeleted = false ) : HipchatGetAllUsersResponse
GetAllWebhooks ( int roomId, int startIndex, int maxResults ) : HipchatGetAllWebhooksResponse
GetAllWebhooks ( string roomName, int startIndex, int maxResults ) : HipchatGetAllWebhooksResponse
GetEmoticon ( int id ) : HipchatGetEmoticonResponse
GetEmoticon ( string shortcut = "" ) : HipchatGetEmoticonResponse
GetRoom ( int roomId ) : HipchatGetRoomResponse
GetRoom ( string roomName ) : HipchatGetRoomResponse
GetUserInfo ( int userId ) : HipchatGetUserInfoResponse
GetUserInfo ( string emailOrMentionName ) : HipchatGetUserInfoResponse
HipchatClient ( string authToken = null ) : System	Creates a new HipchatClient, you can pass in an optional authToken, or by default it will look in the web/app config file appSettings for 'hipchat_auth_token'
PrivateMessageUser ( string idOrEmailOrMention, string message, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Text ) : void
SendNotification ( int roomId, SendRoomNotificationRequest request ) : bool
SendNotification ( int roomId, string message, RoomColors backgroundColor = RoomColors.Yellow, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Html ) : bool
SendNotification ( string roomName, SendRoomNotificationRequest request ) : bool
SendNotification ( string roomName, string message, RoomColors backgroundColor = RoomColors.Yellow, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Html ) : bool
SetTopic ( int roomId, string topic ) : bool
SetTopic ( string roomName, string topic ) : bool
ShareFileWithRoom ( string roomName, string fileFullPath, string message = null ) : bool
UpdatePhoto ( string idOrEmail, string photo ) : bool
UpdateRoom ( int roomId, UpdateRoomRequest request ) : bool
UpdateRoom ( string roomName, UpdateRoomRequest request ) : bool
UpdateUser ( string idOrEmail, UpdateUserRequest request ) : bool
ViewRecentRoomHistory ( string roomName, string notBefore = "", string timezone = "UTC", int startIndex, int maxResults = 100 ) : HipchatViewRoomHistoryResponse
ViewRoomHistory ( string roomName, string date = "recent", string timezone = "UTC", int startIndex, int maxResults = 100, bool reverse = true ) : HipchatViewRoomHistoryResponse

Private Methods

Méthode	Description
ConfigureSerializer ( ) : void
JsonSerializerConfigScope ( ) : JsConfigScope

Method Details

AddMember() public méthode

public AddMember ( string roomName, string idOrEmail ) : bool
roomName	string
idOrEmail	string
Résultat	bool

CreateRoom() public méthode

public CreateRoom ( CreateRoomRequest request ) : HipchatCreateRoomResponse
request	CreateRoomRequest
Résultat	HipchatCreateRoomResponse

CreateRoom() public méthode

public CreateRoom ( string nameOfRoom, bool guestAccess = false, string ownerUserId = null, RoomPrivacy privacy = RoomPrivacy.Public ) : HipchatCreateRoomResponse
nameOfRoom	string
guestAccess	bool
ownerUserId	string
privacy	RoomPrivacy
Résultat	HipchatCreateRoomResponse

CreateUser() public méthode

public CreateUser ( CreateUserRequest request ) : HipchatCreateUserResponse
request	CreateUserRequest
Résultat	HipchatCreateUserResponse

CreateWebHook() public méthode

public CreateWebHook ( int roomId, string url, string pattern, Hipchat.Models.RoomEvent eventType, string name ) : CreateWebHookResponse
roomId	int
url	string
pattern	string
eventType	Hipchat.Models.RoomEvent
name	string
Résultat	CreateWebHookResponse

CreateWebHook() public méthode

public CreateWebHook ( string roomName, Hipchat.Models.Requests.CreateWebHookRequest request ) : CreateWebHookResponse
roomName	string
request	Hipchat.Models.Requests.CreateWebHookRequest
Résultat	CreateWebHookResponse

CreateWebHook() public méthode

public CreateWebHook ( string roomName, string url, string pattern, Hipchat.Models.RoomEvent eventType, string name ) : CreateWebHookResponse
roomName	string
url	string
pattern	string
eventType	Hipchat.Models.RoomEvent
name	string
Résultat	CreateWebHookResponse

DeleteRoom() public méthode

public DeleteRoom ( int roomId ) : bool
roomId	int
Résultat	bool

DeleteRoom() public méthode

public DeleteRoom ( string roomName ) : bool
roomName	string
Résultat	bool

DeleteUser() public méthode

public DeleteUser ( string idOrEmail ) : bool
idOrEmail	string
Résultat	bool

DeleteWebhook() public méthode

public DeleteWebhook ( int roomId, int webHookId ) : bool
roomId	int
webHookId	int
Résultat	bool

DeleteWebhook() public méthode

public DeleteWebhook ( string roomName, int webHookId ) : bool
roomName	string
webHookId	int
Résultat	bool

GenerateToken() public méthode

public GenerateToken ( GrantType grantType, IEnumerable scopes, string username = null, string code = null, string redirectUri = null, string password = null, string refreshToken = null ) : HipchatGenerateTokenResponse
grantType	GrantType
scopes	IEnumerable
username	string
code	string
redirectUri	string
password	string
refreshToken	string
Résultat	HipchatGenerateTokenResponse

GetAllEmoticons() public méthode

public GetAllEmoticons ( int startIndex, int maxResults = 100, EmoticonType type = EmoticonType.All ) : HipchatGetAllEmoticonsResponse
startIndex	int
maxResults	int
type	EmoticonType
Résultat	HipchatGetAllEmoticonsResponse

GetAllRooms() public méthode

public GetAllRooms ( int startIndex, int maxResults = 100, bool includePrivate = false, bool includeArchived = false ) : HipchatGetAllRoomsResponse
startIndex	int
maxResults	int
includePrivate	bool
includeArchived	bool
Résultat	HipchatGetAllRoomsResponse

GetAllUsers() public méthode

public GetAllUsers ( int startIndex, int maxResults = 100, bool includeGuests = false, bool includeDeleted = false ) : HipchatGetAllUsersResponse
startIndex	int
maxResults	int
includeGuests	bool
includeDeleted	bool
Résultat	HipchatGetAllUsersResponse

GetAllWebhooks() public méthode

public GetAllWebhooks ( int roomId, int startIndex, int maxResults ) : HipchatGetAllWebhooksResponse
roomId	int
startIndex	int
maxResults	int
Résultat	HipchatGetAllWebhooksResponse

GetAllWebhooks() public méthode

public GetAllWebhooks ( string roomName, int startIndex, int maxResults ) : HipchatGetAllWebhooksResponse
roomName	string
startIndex	int
maxResults	int
Résultat	HipchatGetAllWebhooksResponse

GetEmoticon() public méthode

public GetEmoticon ( int id ) : HipchatGetEmoticonResponse
id	int
Résultat	HipchatGetEmoticonResponse

GetEmoticon() public méthode

public GetEmoticon ( string shortcut = "" ) : HipchatGetEmoticonResponse
shortcut	string
Résultat	HipchatGetEmoticonResponse

GetRoom() public méthode

public GetRoom ( int roomId ) : HipchatGetRoomResponse
roomId	int
Résultat	HipchatGetRoomResponse

GetRoom() public méthode

public GetRoom ( string roomName ) : HipchatGetRoomResponse
roomName	string
Résultat	HipchatGetRoomResponse

GetUserInfo() public méthode

public GetUserInfo ( int userId ) : HipchatGetUserInfoResponse
userId	int
Résultat	HipchatGetUserInfoResponse

GetUserInfo() public méthode

public GetUserInfo ( string emailOrMentionName ) : HipchatGetUserInfoResponse
emailOrMentionName	string
Résultat	HipchatGetUserInfoResponse

HipchatClient() public méthode

Creates a new HipchatClient, you can pass in an optional authToken, or by default it will look in the web/app config file appSettings for 'hipchat_auth_token'

public HipchatClient ( string authToken = null ) : System
authToken	string	the auth token given by hipchat
Résultat	System

PrivateMessageUser() public méthode

public PrivateMessageUser ( string idOrEmailOrMention, string message, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Text ) : void
idOrEmailOrMention	string
message	string
notify	bool
messageFormat	HipchatMessageFormat
Résultat	void

SendNotification() public méthode

public SendNotification ( int roomId, SendRoomNotificationRequest request ) : bool
roomId	int
request	SendRoomNotificationRequest
Résultat	bool

SendNotification() public méthode

public SendNotification ( int roomId, string message, RoomColors backgroundColor = RoomColors.Yellow, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Html ) : bool
roomId	int
message	string
backgroundColor	RoomColors
notify	bool
messageFormat	HipchatMessageFormat
Résultat	bool

SendNotification() public méthode

public SendNotification ( string roomName, SendRoomNotificationRequest request ) : bool
roomName	string
request	SendRoomNotificationRequest
Résultat	bool

SendNotification() public méthode

public SendNotification ( string roomName, string message, RoomColors backgroundColor = RoomColors.Yellow, bool notify = false, HipchatMessageFormat messageFormat = HipchatMessageFormat.Html ) : bool
roomName	string
message	string
backgroundColor	RoomColors
notify	bool
messageFormat	HipchatMessageFormat
Résultat	bool

SetTopic() public méthode

public SetTopic ( int roomId, string topic ) : bool
roomId	int
topic	string
Résultat	bool

SetTopic() public méthode

public SetTopic ( string roomName, string topic ) : bool
roomName	string
topic	string
Résultat	bool

ShareFileWithRoom() public méthode

public ShareFileWithRoom ( string roomName, string fileFullPath, string message = null ) : bool
roomName	string
fileFullPath	string
message	string
Résultat	bool

UpdatePhoto() public méthode

public UpdatePhoto ( string idOrEmail, string photo ) : bool
idOrEmail	string
photo	string
Résultat	bool

UpdateRoom() public méthode

public UpdateRoom ( int roomId, UpdateRoomRequest request ) : bool
roomId	int
request	UpdateRoomRequest
Résultat	bool

UpdateRoom() public méthode

public UpdateRoom ( string roomName, UpdateRoomRequest request ) : bool
roomName	string
request	UpdateRoomRequest
Résultat	bool

UpdateUser() public méthode

public UpdateUser ( string idOrEmail, UpdateUserRequest request ) : bool
idOrEmail	string
request	UpdateUserRequest
Résultat	bool

ViewRecentRoomHistory() public méthode

public ViewRecentRoomHistory ( string roomName, string notBefore = "", string timezone = "UTC", int startIndex, int maxResults = 100 ) : HipchatViewRoomHistoryResponse
roomName	string
notBefore	string
timezone	string
startIndex	int
maxResults	int
Résultat	HipchatViewRoomHistoryResponse

ViewRoomHistory() public méthode

public ViewRoomHistory ( string roomName, string date = "recent", string timezone = "UTC", int startIndex, int maxResults = 100, bool reverse = true ) : HipchatViewRoomHistoryResponse
roomName	string
date	string
timezone	string
startIndex	int
maxResults	int
reverse	bool
Résultat	HipchatViewRoomHistoryResponse