public class | source

Messages

Extends:

CiscoSpark → Messages

Spark Messages

See:

https://developer.ciscospark.com/resource-messages.html

Test:

CiscoSpark.messages

Constructor Summary

Public Constructor
public	constructor(accessToken: string, userAgent: string)

Method Summary

Public Methods
public	create(params: MessageCreateParams, callback: requestCallback): * Create a Message Posts a plain text message, and optionally, a media content attachment, to a room.
public	createToPersonEmail(email: string, params: string \| MessageCreateParams, callback: requestCallback): * Create a Message to a person via email
public	createToPersonId(personId: string, params: string \| MessageCreateParams, callback: requestCallback): * Create a Message for a Person
public	createToRoom(roomId: string, params: string \| MessageCreateParams, callback: requestCallback): * Create a Message to a Room
public	delete(messageId: string, callback: requestCallback): * Delete a message
public	get(messageId: string, callback: requestCallback): * Get a message
public	list(params: MessageListParams, callback: requestCallback): * List Messages Lists all messages in a room.

Inherited Summary

From class CiscoSpark
public set	requestCallback: requestCallback
protected	accessToken: string
protected	apiUrl: string
protected	idName: string
protected	userAgent: string
public abstract	checkId(id: string): boolean Check Id
public	create(params: Object, callback: requestCallback): * Create an object
public	delete(id: string, callback: requestCallback): * Delete an Object
public	get(id: string, callback: requestCallback): * Get an object
public	list(params: Object, callback: requestCallback) List objects
public	update(id: string, params: Object, callback: requestCallback): * Update an object
protected	request(options: Object, callback: requestCallback): * Make a request

Public Constructors

public constructor(accessToken: string, userAgent: string) source

Constructor for abstract class

Override:

CiscoSpark#constructor

Params:

Name	Type	Attribute	Description
accessToken	string	optional	Your Cisco Spark accesstoken
userAgent	string	optional	User Agent request header

Public Methods

public create(params: MessageCreateParams, callback: requestCallback): * source

Create a Message Posts a plain text message, and optionally, a media content attachment, to a room.

Override:

CiscoSpark#create

Params:

Name	Type	Attribute	Description
params	MessageCreateParams		see https://developer.ciscospark.com/endpoint-messages-post.html
callback	requestCallback

Return:

Test:

CiscoSpark.messages - Test Errors should error when create without RoomId

public createToPersonEmail(email: string, params: string | MessageCreateParams, callback: requestCallback): * source

Create a Message to a person via email

Params:

Name	Type	Attribute	Description
email	string		Email address
params	string \| MessageCreateParams		Markdown formatted message string or Request parameters object
callback	requestCallback

Return:

Test:

CiscoSpark.messages - DirectToPerson should send Message to a Person via Email

public createToPersonId(personId: string, params: string | MessageCreateParams, callback: requestCallback): * source

Create a Message for a Person

Params:

Name	Type	Attribute	Description
personId	string		Spark Person ID
params	string \| MessageCreateParams		Markdown formatted message string or Request parameters object
callback	requestCallback

Return:

Test:

CiscoSpark.messages - DirectToPerson should send Message to a Person via ID

public createToRoom(roomId: string, params: string | MessageCreateParams, callback: requestCallback): * source

Create a Message to a Room

Params:

Name	Type	Attribute	Description
roomId	string		Spark Room ID
params	string \| MessageCreateParams		Markdown formatted message string or Request parameters object
callback	requestCallback

Return:

Test:

CiscoSpark.messages - Chat Room should send Message to a Room

public delete(messageId: string, callback: requestCallback): * source

Delete a message

Override:

CiscoSpark#delete

Params:

Name	Type	Attribute	Description
messageId	string		Spark Message ID
callback	requestCallback

Return:

Test:

public get(messageId: string, callback: requestCallback): * source

Get a message

Override:

CiscoSpark#get

Params:

Name	Type	Attribute	Description
messageId	string		Spark Message ID
callback	requestCallback

Return:

Test:

public list(params: MessageListParams, callback: requestCallback): * source

List Messages Lists all messages in a room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date.

Override:

CiscoSpark#list

Params:

Name	Type	Attribute	Description
params	MessageListParams		see https://developer.ciscospark.com/endpoint-messages-get.html
callback	requestCallback