C# Class BatchBook.Communication

Show file Open project: batchblue/batchbook-net Class Usage Examples

Public Methods

Method	Description
AddParticipant ( int communicationId, int contactId, string role ) : void
AddParticipant ( string apiKey, int communicationId, int contactId, string role ) : void
Create ( string subject, string body, System.DateTime date, string ctype ) : int
Create ( string apiKey, string subject, string body, System.DateTime date, string ctype ) : int
Destroy ( int communcationId ) : void
Destroy ( string apiKey, int communcationId ) : void
Get ( int communicationId ) : Communication
Get ( string apiKey, int communicationId ) : Communication
GetParticipants ( string apiKey ) : Participant[]
List ( int limit, int offset ) : BatchBook.Communication[]
List ( string apiKey, int limit, int offset ) : BatchBook.Communication[]
ListByCompany ( int companyId ) : BatchBook.Communication[]
ListByCompany ( string apiKey, int companyId ) : BatchBook.Communication[]
ListByPerson ( int personId ) : BatchBook.Communication[]
ListByPerson ( string apiKey, int personId ) : BatchBook.Communication[]
ListParticipants ( int communicationId ) : Participant[]
ListParticipants ( int communicationId, string role ) : Participant[]
ListParticipants ( string apiKey, int communicationId ) : Participant[]
ListParticipants ( string apiKey, int communicationId, string role ) : Participant[]
RemoveParticipant ( int communicationId, int contactId, string role ) : void
RemoveParticipant ( string apiKey, int communicationId, int contactId, string role ) : void
Search ( string ctype, int contactId, System.DateTime updatedSince, System.DateTime updatedBefore, System.DateTime createdSince, System.DateTime createdBefore ) : BatchBook.Communication[]
Search ( string apiKey, string ctype, int contactId, System.DateTime updatedSince, System.DateTime updatedBefore, System.DateTime createdSince, System.DateTime createdBefore ) : BatchBook.Communication[]
Update ( int communcationId, string subject, string body, System.DateTime date, string ctype ) : void
Update ( string apiKey, int communcationId, string subject, string body, System.DateTime date, string ctype ) : void

Private Methods

Method	Description
BuildList ( XmlReader rdr ) : BatchBook.Communication[]
Communication ( XmlReader rdr ) : System

Method Details

AddParticipant() public static method

public static AddParticipant ( int communicationId, int contactId, string role ) : void
communicationId	int
contactId	int
role	string
return	void

AddParticipant() public static method

public static AddParticipant ( string apiKey, int communicationId, int contactId, string role ) : void
apiKey	string
communicationId	int
contactId	int
role	string
return	void

Create() public static method

public static Create ( string subject, string body, System.DateTime date, string ctype ) : int
subject	string
body	string
date	System.DateTime
ctype	string
return	int

Create() public static method

public static Create ( string apiKey, string subject, string body, System.DateTime date, string ctype ) : int
apiKey	string
subject	string
body	string
date	System.DateTime
ctype	string
return	int

Destroy() public static method

public static Destroy ( int communcationId ) : void
communcationId	int
return	void

Destroy() public static method

public static Destroy ( string apiKey, int communcationId ) : void
apiKey	string
communcationId	int
return	void

Get() public static method

public static Get ( int communicationId ) : Communication
communicationId	int
return	Communication

Get() public static method

public static Get ( string apiKey, int communicationId ) : Communication
apiKey	string
communicationId	int
return	Communication

GetParticipants() public method

public GetParticipants ( string apiKey ) : Participant[]
apiKey	string
return	Participant[]

List() public static method

public static List ( int limit, int offset ) : BatchBook.Communication[]
limit	int
offset	int
return	BatchBook.Communication[]

List() public static method

public static List ( string apiKey, int limit, int offset ) : BatchBook.Communication[]
apiKey	string
limit	int
offset	int
return	BatchBook.Communication[]

ListByCompany() public static method

public static ListByCompany ( int companyId ) : BatchBook.Communication[]
companyId	int
return	BatchBook.Communication[]

ListByCompany() public static method

public static ListByCompany ( string apiKey, int companyId ) : BatchBook.Communication[]
apiKey	string
companyId	int
return	BatchBook.Communication[]

ListByPerson() public static method

public static ListByPerson ( int personId ) : BatchBook.Communication[]
personId	int
return	BatchBook.Communication[]

ListByPerson() public static method

public static ListByPerson ( string apiKey, int personId ) : BatchBook.Communication[]
apiKey	string
personId	int
return	BatchBook.Communication[]

ListParticipants() public static method

public static ListParticipants ( int communicationId ) : Participant[]
communicationId	int
return	Participant[]

ListParticipants() public static method

public static ListParticipants ( int communicationId, string role ) : Participant[]
communicationId	int
role	string
return	Participant[]

ListParticipants() public static method

public static ListParticipants ( string apiKey, int communicationId ) : Participant[]
apiKey	string
communicationId	int
return	Participant[]

ListParticipants() public static method

public static ListParticipants ( string apiKey, int communicationId, string role ) : Participant[]
apiKey	string
communicationId	int
role	string
return	Participant[]

RemoveParticipant() public static method

public static RemoveParticipant ( int communicationId, int contactId, string role ) : void
communicationId	int
contactId	int
role	string
return	void

RemoveParticipant() public static method

public static RemoveParticipant ( string apiKey, int communicationId, int contactId, string role ) : void
apiKey	string
communicationId	int
contactId	int
role	string
return	void

Search() public static method

public static Search ( string ctype, int contactId, System.DateTime updatedSince, System.DateTime updatedBefore, System.DateTime createdSince, System.DateTime createdBefore ) : BatchBook.Communication[]
ctype	string
contactId	int
updatedSince	System.DateTime
updatedBefore	System.DateTime
createdSince	System.DateTime
createdBefore	System.DateTime
return	BatchBook.Communication[]

Search() public static method

public static Search ( string apiKey, string ctype, int contactId, System.DateTime updatedSince, System.DateTime updatedBefore, System.DateTime createdSince, System.DateTime createdBefore ) : BatchBook.Communication[]
apiKey	string
ctype	string
contactId	int
updatedSince	System.DateTime
updatedBefore	System.DateTime
createdSince	System.DateTime
createdBefore	System.DateTime
return	BatchBook.Communication[]

Update() public static method

public static Update ( int communcationId, string subject, string body, System.DateTime date, string ctype ) : void
communcationId	int
subject	string
body	string
date	System.DateTime
ctype	string
return	void

Update() public static method

public static Update ( string apiKey, int communcationId, string subject, string body, System.DateTime date, string ctype ) : void
apiKey	string
communcationId	int
subject	string
body	string
date	System.DateTime
ctype	string
return	void