WorkflowThread

coordinates

const coordinatesText = document.getElementById("coordinates");
coordinatesText.innerText = workflowApi.currentThread.coordinates;

createdBy

if(workflowApi.session.currentUser.id !==  workflowApi.currentThread.createdBy.id){
 	deleteButton.style.visibility='hidden';
	}

entries

const firstEntry =  workflowApi.currentThread.entries[0];

expirationDate

workflowApi.currentThread.expirationDate = workflowApi.enums.ExpirationType.ThreeMonths;

hasDataSnapshot

setHasDataSnapshotButton.onclick = () => {
     	workflowApi.currentThread.hasDataSnapshot = true;
}

hasReportSnapshot

setHasReportSnapshotButton.onclick = () => {
    	workflowApi.currentThread.hasReportSnapshot = true;
}

id

const threadId = workflowApi.currentThread.id;
console log(" The current thread id is: " + threadId);

isEmailParticipents

setEmailParticipentsButton.onclick = () => {
    	workflowApi.currentThread.isEmailParticipents = true;
}

isReportSpecific

setReportSpecificButton.onclick = () => {
		workflowApi.currentThread.isReportSpecific = true;
}

subtitle

const detailsInput = document.getElementById("details");
detailsInput.value = workflowApi.currentThread.subtitle;
detailsInput.onkeyup = function(event) {
	const input = event.target.value;
	workflowApi.currentThread.subtitle = input;
}

title

const subjectInput = document.getElementById("subject");
subjectInput.value = workflowApi.currentThread.title;
subjectInput.onkeyup = function(event){
	const input = event.target.value;
	workflowApi.currentThread.title = input;
}

type

if(workflowApi.currentThread.type === workflowApi.enums.WorkflowThreadType.Cell){
   	console.log("The current Thread is on a cell");
}

validation

A function that is being used by the API infrastructure to indicate if a thread is valid for saving. You should use this to set a customize validation function to control when the thread is valid for saving or not.

cApi.currentThread.validation = () => {
	const currentEntry =  workflowApi.currentThread.entries[0];
	const tasks = document.getElementById('tasks
	return validateTaskList(currentEntry, tasks);
}

addContacts

This function adds contacts or users to the thread.

fucntion addAllUsersAsContacts(){
		workflowApi.currentThread.addContacts(workflowApi.utilities.getUsersAndRoles());
}

Parameters

• newContacts:Contact[]

  Array of Contacts - the contacts you want to add for the thread

Returns Promise<void>

addNewEntry

This function adds a new entry to the thread.

createNewEntryButton.addEventListener('click', () => {
		const newEntry = workflowApi.currentThread.addNewEntry();
 	newEntry.save();
});

Returns Entry

Entry-The new Entry for you to add to the thread.

getContacts

Returns the list of contacts or users attached to a thread.

cApi.currentThread.getContacts().then((currentContact) =>{
		console.log(currentContact.name);
});

Returns Promise<Contact[]>

users in the app that get updates about the thread and can view it.

getEntriesByDate

This function returns all entries in a given thread from the specified date-time.

const entriesSinceYesterday = workflowApi.currentThread.getEntriesByDate(today.getDate() - 1);
console.log("The number of entries since yesterday is " + entriesSinceYesterday.length);

Parameters

• startDate:Date

  the time from where to get the entries.

Returns Entry[]

the entries from a time that is relevant for your need.

getLastEntries

This function returns the last set of entries in a given thread. Set the count argument to specify the number to return.

const currentEntry = workflowApi.currentThread.getLastEntries(1)[0];

Parameters

• count:number

  The number of Entries that was last added.

Returns Entry[]

Entries that was last added.

notifyChangeToContacts

This function triggers the framework to notify all of a thread's contacts that there is an update for this thread.

fucntion CancelThread(){
 	workflowApi.currentThread.title = "canceled:" + workflowApi.currentThread.title;
		workflowApi.currentThread.save().then(() =>{
			workflowApi.currentThread.notifyChangeToContacts();
 	});
}

Returns Promise<void>

removeContacts

This function removes contacts from the thread.

fucntion removeAllContacts(){
		workflowApi.currentThread.getContacts().forEach((contact) =>{
			workflowApi.currentThread.removeContacts([contact.id]);
		});
}

Parameters

• ids:string[]

  Array of string - id of contacts that you want to remove from the thread

Returns Promise<void>

removeEntry

This function removes the selected entry object from the thread's entries list.

removeLastEntryButton.onclick = function(event) {
	 const lastEntry =  workflowApi.currentThread.getLastEntries(1)[0];
	 workflowApi.currentThread.removeEntry(lastEntry.id);
}

Parameters

• entryId:string

  the entry that you want to delete's id

Returns void

removeThread

This function removes a Thread by it's given id. You should use it when you require to remove the current thread or some other thread.

const removeThreadButton = document.createElement("button");
removeThreadButton.addEventListener('click', () => {
	workflowApi.currentThread.removeThread().then(() => {
 	workflowApi.canvas.closeWindow();
	});
});

Returns Promise<void>

save

This function saves changes made to the thread object.

workflowApi.onBeforeUnload = () => {
		workflowApi.currentThread.save();
}

Returns Promise<void>