MoxiWorks.Platform.EventService Class Reference

Moxi Works Platform Event entities represent appointments, meetings or other events scheduled for an agent. More...

Inheritance diagram for MoxiWorks.Platform.EventService:

Public Member Functions
	EventService (IMoxiWorksClient client)
async Task< Response< Event > >	CreateEventAsync (Event cmaEvent)
	Create an event More...
async Task< Response< Event > >	UpdateEventAsync (Event updateEvent)
	Update an existing event. More...
async Task< Response< Event > >	GetEventAsync (string agentId, AgentIdType agentIdType, string partnerEventId)
	Get an Event if exists. More...
async Task< Response< EventResults > >	GetEventsByDateAsync (string agentId, AgentIdType agentIdType, int eventStart, int eventEnd)
async Task< Response< EventDeleteResult > >	DeleteEventAsync (string agentId, AgentIdType agentIdType, string eventId)
	Delete an existing event More...

Properties
IMoxiWorksClient	Client [get, set]
Properties inherited from MoxiWorks.Platform.Interfaces.IEventService
IMoxiWorksClient	Client [get, set]

Detailed Description

Moxi Works Platform Event entities represent appointments, meetings or other events scheduled for an agent.

Member Function Documentation

CreateEventAsync()

async Task<Response<Event> > MoxiWorks.Platform.EventService.CreateEventAsync

(

Event

cmaEvent

)

Create an event

Parameters

cmaEvent

The Event you want to create

Returns

The event you create.

Implements MoxiWorks.Platform.Interfaces.IEventService.

DeleteEventAsync()

async Task<Response<EventDeleteResult> > MoxiWorks.Platform.EventService.DeleteEventAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	eventId
	)

Delete an existing event

Parameters

agentId

AgentUuid This is the Moxi Works Platform ID of the agent which an Event 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 Event entry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Event entry 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 MoxiWorksAgentID is required and must reference a valid Moxi Works Agent ID for your Event entry request to be accepted. Agent ID for your Buyer Transaction entry request to be accepted.

Parameters

agentIdType	What agentId type you are using.
eventId	This is the unique identifer you use in your system that has been associated with the Event. This data is required and must reference a previously created Event you have created on The Moxi Works Platform.

Returns

if the delete was successful.

Implements MoxiWorks.Platform.Interfaces.IEventService.

GetEventAsync()

async Task<Response<Event> > MoxiWorks.Platform.EventService.GetEventAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	partnerEventId
	)

Get an Event if exists.

Parameters

agentId

AgentUuid This is the Moxi Works Platform ID of the agent which an Event 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 Event entry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Event entry 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 MoxiWorksAgentID is required and must reference a valid Moxi Works Agent ID for your Event entry request to be accepted. Agent ID for your Buyer Transaction entry request to be accepted.

Parameters

agentIdType	What agentId type you are using.
partnerEventId	This is the unique identifer you use in your system that has been associated with the Event that you are searching for.

Returns

returns the Event or an empty Event if not

Implements MoxiWorks.Platform.Interfaces.IEventService.

GetEventsByDateAsync()

async Task<Response<EventResults> > MoxiWorks.Platform.EventService.GetEventsByDateAsync	(	string	agentId,
		AgentIdType	agentIdType,
		int	eventStart,
		int	eventEnd
	)

Parameters

agentId

AgentUuid This is the Moxi Works Platform ID of the agent which an Event 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 Event entry request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Event entry 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 MoxiWorksAgentID is required and must reference a valid Moxi Works Agent ID for your Event entry request to be accepted. Agent ID for your Buyer Transaction entry request to be accepted.

Parameters

agentIdType	What agentId type you are using.
eventStart	This is the earliest time that you are searching for an Event to be in. This data is required and must be a Unix timestamp before eventEnd.
eventEnd	This is the latest time that you are searching for an Event to be in. This data is required and must be a Unix timestamp after evntStart.

Returns

List of event within the date params

Implements MoxiWorks.Platform.Interfaces.IEventService.

UpdateEventAsync()

async Task<Response<Event> > MoxiWorks.Platform.EventService.UpdateEventAsync

(

Event

updateEvent

)

Update an existing event.

Parameters

updateEvent

Event you want to update.

Returns

Implements MoxiWorks.Platform.Interfaces.IEventService.

---

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

• EventService.cs