C# Class InteractuaMovil.ContactoSms.Api.Groups

Inheritance: InteractuaMovil.ContactoSms.Api.ApiRequest, interfaces.IGroups
Show file Open project: interactuamovil/im-contactosms-sdk-dotnet

Public Methods

Method Description
Add ( string ShortName, string Name, string Description ) : ResponseObjects.ApiResponse

Creates a new group
AddContact ( string ShortName, string Msisdn ) : ResponseObjects.ApiResponse

Add a contact to a group
Delete ( string ShortName ) : ResponseObjects.ApiResponse

Deletes a group
Get ( string ShortName ) : ResponseObjects.ApiResponse

Gets a single group
GetContactList ( string ShortName ) : ResponseObjects.ApiResponse>

Gets group's contacts list
GetList ( ) : ResponseObjects.ApiResponse>

Gets the list of groups for the account
RemoveContact ( string ShortName, string Msisdn ) : ResponseObjects.ApiResponse

Removes a contact from a group
Update ( string ShortName, string Name, string Description, string NewShortName = null ) : ResponseObjects.ApiResponse

Updates a group

Private Methods

Method Description
Groups ( string ApiKey, string SecretKey, string ApiUrl ) : System
Groups ( string ApiKey, string SecretKey, string ApiUrl, string ProxyAddress, string UserName, string Password ) : System

Method Details

Add() public method

Creates a new group
public Add ( string ShortName, string Name, string Description ) : ResponseObjects.ApiResponse
ShortName string Group short name
Name string Group name
Description string Group description
return ResponseObjects.ApiResponse

AddContact() public method

Add a contact to a group
public AddContact ( string ShortName, string Msisdn ) : ResponseObjects.ApiResponse
ShortName string group short name
Msisdn string contact msisdn
return ResponseObjects.ApiResponse

Delete() public method

Deletes a group
public Delete ( string ShortName ) : ResponseObjects.ApiResponse
ShortName string Group short name
return ResponseObjects.ApiResponse

Get() public method

Gets a single group
public Get ( string ShortName ) : ResponseObjects.ApiResponse
ShortName string Group's short name
return ResponseObjects.ApiResponse

GetContactList() public method

Gets group's contacts list
public GetContactList ( string ShortName ) : ResponseObjects.ApiResponse>
ShortName string group short name
return ResponseObjects.ApiResponse>

GetList() public method

Gets the list of groups for the account
public GetList ( ) : ResponseObjects.ApiResponse>
return ResponseObjects.ApiResponse>

RemoveContact() public method

Removes a contact from a group
public RemoveContact ( string ShortName, string Msisdn ) : ResponseObjects.ApiResponse
ShortName string group short name
Msisdn string contact msisdn
return ResponseObjects.ApiResponse

Update() public method

Updates a group
public Update ( string ShortName, string Name, string Description, string NewShortName = null ) : ResponseObjects.ApiResponse
ShortName string Group's short name to locate the group
Name string Group name
Description string Group Description
NewShortName string New group short name
return ResponseObjects.ApiResponse