MoxiWorks.Platform.TaskService Class Reference

Moxi Works Platform Task entities represent tasks that agents need to perform on behalf of, or in relation to their contacts. More...

Inheritance diagram for MoxiWorks.Platform.TaskService:

Public Member Functions
	TaskService (IMoxiWorksClient client)
async Task< Response< Task > >	GetTaskAsync (string agentId, AgentIdType agentIdType, string partnerContactId, string partnerTaskId)
	Returns the specified Task if it exist. More...
async Task< Response< Task > >	UpdateTaskAsync (Task task)
	update an existing task More...
async Task< Response< Task > >	CreateTaskAsync (Task task)
async Task< Response< TaskResponse > >	GetTasksDueForContactForAsync (string agentId, AgentIdType agentIdType, string partnerContactId, int pageNumber=1)
async Task< Response< TaskResponse > >	GetTaskDueBetweenAsync (string agentId, AgentIdType agentIdType, DateTime startDate, DateTime endDate, int pageNumber=1)
	Return all agents tasks due between start and end data. More...
async Task< Response< TaskResponse > >	GetTasksAsync (string agentId, AgentIdType agentIdType, DateTime? startDate, DateTime? endDate, string partnerContactId, int pageNumber=1)
	Return a list of agents tasks based on multople parameters. More...

Detailed Description

Moxi Works Platform Task entities represent tasks that agents need to perform on behalf of, or in relation to their contacts.

Member Function Documentation

CreateTaskAsync()

async Task<Response<Task> > MoxiWorks.Platform.TaskService.CreateTaskAsync

(

Task

task

)

Parameters

task	the task you want to create.

Returns

The Response containing the created Task

Implements MoxiWorks.Platform.Interfaces.ITaskService.

GetTaskAsync()

async Task<Response<Task> > MoxiWorks.Platform.TaskService.GetTaskAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	partnerContactId,
		string	partnerTaskId
	)

Returns the specified Task if it exist.

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
partnerContactId	This is the unique identifer you use in your system that has been associated with the Contact that this Task regards.
partnerTaskId

Returns

Task Response empty if task does not exist

Implements MoxiWorks.Platform.Interfaces.ITaskService.

GetTaskDueBetweenAsync()

async Task<Response<TaskResponse> > MoxiWorks.Platform.TaskService.GetTaskDueBetweenAsync	(	string	agentId,
		AgentIdType	agentIdType,
		DateTime	startDate,
		DateTime	endDate,
		int	pageNumber = 1
	)

Return all agents tasks due between start and end data.

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
startDate	Date to start Searching
endDate	Date to end Search

This is the unique identifer you use in your system that has been associated with the Contact that this Task regards.

Parameters

pageNumber

The page you want to view.

Returns

Response with a list of Task in a Task Response object

Implements MoxiWorks.Platform.Interfaces.ITaskService.

GetTasksAsync()

async Task<Response<TaskResponse> > MoxiWorks.Platform.TaskService.GetTasksAsync	(	string	agentId,
		AgentIdType	agentIdType,
		DateTime?	startDate,
		DateTime?	endDate,
		string	partnerContactId,
		int	pageNumber = 1
	)

Return a list of agents tasks based on multople parameters.

Parameters

agentId	Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. Agent ID for your Group request to be accepted.
agentIdType	What agentId type you are using.
startDate	Date to start Searching
endDate	Date to end Search
partnerContactId	This is the unique identifer you use in your system that has been associated with the Contact that this Task regards.
pageNumber	The page you want to view.

Returns

Response with a list of Task in a Task Response object

Implements MoxiWorks.Platform.Interfaces.ITaskService.

GetTasksDueForContactForAsync()

async Task<Response<TaskResponse> > MoxiWorks.Platform.TaskService.GetTasksDueForContactForAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	partnerContactId,
		int	pageNumber = 1
	)

Return a list of tasks for a particular contact.

Parameters

agentId	Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. This is the Moxi Works Platform ID of the agent which an Group entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Group request to be accepted. Agent ID for your Group request to be accepted.
agentIdType	What agentId type you are using.
partnerContactId	This is the unique identifer you use in your system that has been associated with the Contact that this Task regards.
pageNumber	The page you want to view.

Returns

Response with a list of Task in a Task Response object

Implements MoxiWorks.Platform.Interfaces.ITaskService.

UpdateTaskAsync()

async Task<Response<Task> > MoxiWorks.Platform.TaskService.UpdateTaskAsync

(

Task

task

)

update an existing task

Parameters

task	The Task you want to update

Returns

The Response containing the update Task

Implements MoxiWorks.Platform.Interfaces.ITaskService.

---

The documentation for this class was generated from the following file:

• TaskService.cs