C# Class INgageNetworks.Api

Mostrar archivo Open project: IngageNetworks/GhostWriter Class Usage Examples

Public Methods

Method	Description
Api ( string userName, string password, string apiKey ) : System
ArchiveContainer ( int containerId ) : System.Boolean
Authenticate ( ) : void
CreateContainer ( string name, Status status ) : Container
DeleteContainer ( int containerId ) : System.Boolean
DraftContainer ( int containerId ) : System.Boolean
PrepareCall ( IRestRequest request ) : void
PublishContainer ( int containerId ) : System.Boolean
ReadContainer ( int containerId ) : Container
ReadContainers ( int parentId, int limit, int offset, int order, Status statuses ) : ContainerCollection
ReviewContainer ( int containerId ) : System.Boolean
UpdateContainer ( int containerId, string name ) : Container

Private Methods

Method	Description
ContainerStatus ( Status status, int containerId ) : System.Boolean

Method Details

Api() public method

public Api ( string userName, string password, string apiKey ) : System
userName	string
password	string
apiKey	string
return	System

ArchiveContainer() public method

public ArchiveContainer ( int containerId ) : System.Boolean
containerId	int
return	System.Boolean

Authenticate() public method

public Authenticate ( ) : void
return	void

CreateContainer() public method

public CreateContainer ( string name, Status status ) : Container
name	string
status	Status
return	Container

DeleteContainer() public method

public DeleteContainer ( int containerId ) : System.Boolean
containerId	int
return	System.Boolean

DraftContainer() public method

public DraftContainer ( int containerId ) : System.Boolean
containerId	int
return	System.Boolean

PrepareCall() public method

public PrepareCall ( IRestRequest request ) : void
request	IRestRequest
return	void

PublishContainer() public method

public PublishContainer ( int containerId ) : System.Boolean
containerId	int
return	System.Boolean

ReadContainer() public method

public ReadContainer ( int containerId ) : Container
containerId	int
return	Container

ReadContainers() public method

public ReadContainers ( int parentId, int limit, int offset, int order, Status statuses ) : ContainerCollection
parentId	int
limit	int
offset	int
order	int
statuses	Status
return	ContainerCollection

ReviewContainer() public method

public ReviewContainer ( int containerId ) : System.Boolean
containerId	int
return	System.Boolean

UpdateContainer() public method

public UpdateContainer ( int containerId, string name ) : Container
containerId	int
name	string
return	Container