Add our tools to your projects!

Supercharge your apps! Our API gives you access to our tools.

Overview

An activity represents an action done on a ZeenShare account. Each time a method of the api update, create, or delete something, an activity that represents the action is returned. The same activity will also be broadcasted to all other connected accounts and sessions impacted by the action.

Each activity is stored on zeenshare account, and the list of activities of an account is available through the activity_list method. of the api.

Attributes:

Here is the list of common activity attributes available in all types of activities.

type
- The type of the activity. You can use this field to recognize which kind of activity you are treating
id
- The id of the activity. The id is based on the timestamp of the activity, so that the activity ids will be ordered by time
from
- The profile name of the account who created the activity
date
- The timestamp of the activity (represent the specified number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT)
read
- true or false. Indicates if the activity has been read by the user

Folder Activities

FolderDeleteActivity

Is created when a folder is deleted.

Example:

{ 
"type":"com.netsas.activity.folder.FolderDeleteActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0",
"parentFolderId": "mymail@mycompany.com",
"parentFolderName": "Parent folder Name" 
}

Attributes:

folderName
- Name of the deleted folder
folderId
- Id of the deleted folder
parentFolderName
- Name of the parend folder. If the parent folder is the root folder, the name will be ROOT_FOLDER
parentFolderId
- Id of the parent folder

FolderMoveActivity

Is created when a folder is moved from a folder to an other folder.

Example:

{ 
"type":"com.netsas.activity.folder.FolderMoveActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0",
"fromFolderName": "From folder name",
"fromFolderId": "mCiIAIzsVfBq8Qh",
"toFolderName": "To folder name",
"toFolderId": "Cw85smNn0mjwWMj" 
}

Attributes:

folderName
- Name of the moved folder
folderId
- Id of the moved folder
fromFolderName
- Name of the folder who contained the moved folder
fromFolderId
- Id of the folder who contained the moved folder
toFolderName
- Name of the folder who contain now the moved folder
toFolderId
- Id of the folder who contain now the moved folder

FolderNewActivity

Is created when a folder created.

Example:

{ 
"type":"com.netsas.activity.folder.FolderNewActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "New folder name",
"folderId": "A8rEBwtNbi8seR0",
"parentFolderId": "mymail@mycompany.com",
"parentFolderName": "Parent folder Name" 
}

Attributes:

folderName
- Name of the created folder
folderId
- Id of the created folder
parentFolderName
- Name of the parend folder. If the parent folder is the root folder, the name will be ROOT_FOLDER
parentFolderId
- Id of the parent folder

FolderRenameActivity

Is created when a folder is renamed.

Example:

{ 
"type":"com.netsas.activity.folder.FolderRenameActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "New folder name",
"folderId": "A8rEBwtNbi8seR0",
"folderOldName": "Old folder Name" 
}

Attributes:

folderName
- New name of the folder
folderId
- Id of the renamed folder
folderOldName
- The old folder name

FolderShareActivity

Is created when a folder is shared.

Example:

{ 
"type":"com.netsas.activity.folder.FolderShareActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0",
"newCoworkers": "myOtherEmail1@mycompany.com,myOtherEmail2@mycompany.com" 
}

Attributes:

folderName
- Name of the shared folder
folderId
- Id of the shared folder
newCoworkers
- Comma separated list of new coworkers for this shared folders

Document activities

DocumentNewActivity

Is created when a document is added in a folder.

Example:

{ 
"type":"com.netsas.activity.document.DocumentNewActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0",
"thumbUrl": "/api/document/download/page?docId=TVYkXcpzyxvC7ry&docVersionId=6tymxd&proxyType=S160",
"crc32": "4108818463",
"documentId": "TVYkXcpzyxvC7ry",
"name": "myDoc.doc" 
}

Attributes:

folderName
- Name of the parent folder
folderId
- Id of the parent folder
thumbUrl
- Thumb url to show a small preview of the first page of the document
documentId
- Id of new document created
name
- Name of new document created
crc32
- Cyclic redundancy check of the document

DocumentDeleteActivity

Is created when a document is deleted from a folder.

Example:

{ 
"type":"com.netsas.activity.document.DocumentDeleteActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"fromFolderName": "Folder name",
"fromFolderId": "A8rEBwtNbi8seR0",
"documentId": "TVYkXcpzyxvC7ry",
"documentName": "myDoc.doc" 
}

Attributes:

fromFolderName
- Name of the parent folder
fromFolderId
- Id of the parent folder
documentId
- Id of new document deleted
documentName
- Name of new document deleted

DocumentMoveActivity

Is created when a document is moved from a folder to an other folder.

Example:

{
"type":"com.netsas.activity.document.DocumentMoveActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"documentName": "myDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"fromFolderName": "From folder name",
"fromFolderId": "mCiIAIzsVfBq8Qh",
"toFolderName": "To folder name",
"toFolderId": "Cw85smNn0mjwWMj" 
}

Attributes:

documentName
- Name of the moved document
documentId
- Id of the moved document
fromFolderName
- Name of the folder who contained the moved folder
fromFolderId
- Id of the folder who contained the moved folder
toFolderName
- Name of the folder who contain now the moved folder
toFolderId
- Id of the folder who contain now the moved folder

DocumentShareActivity

Is created when a new document is shared.

Example:

{ 
"type":"com.netsas.activity.document.DocumentShareActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"name": "myDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"thumbUrl": "/api/document/download/page?docId=TVYkXcpzyxvC7ry&docVersionId=6tymxd&proxyType=S160"  
}

Attributes:

name
- Name of the shared document
documentId
- Id of the moved document
thumbUrl
- Thumb url to show a small preview of the first page of the document

DocumentRestoreActivity

Is created when a new document is restored.

Example:

{ 
"type":"com.netsas.activity.document.DocumentRestoreActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"documentName": "myDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0"
}

Attributes:

name
- Name of the restored document
documentId
- Id of the moved document
folderName
- Name of the parent folder
folderId
- Id of the parent folder

DocumentRenameActivity

Is created when a new document is renamed.

Example:

{ 
"type":"com.netsas.activity.document.DocumentRenameActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"oldDocumentName": "myDoc.doc",
"documentName": "myNewDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"folderName": "Folder name",
"folderId": "A8rEBwtNbi8seR0"
}

Attributes:

oldDocumentName
- Previous name of the renamed document
documentName
- Name of the renamed document
documentId
- Id of the moved document
folderName
- Name of the parent folder
folderId
- Id of the parent folder

DocumentVersionNewActivity

Is created when a document updated with a new version.

Example:

{ 
"type":"com.netsas.activity.document.DocumentVersionNewActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"documentName": "myNewDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"documentVersionId": "6tymxd",
"crc32": "4108818463",
"thumbUrl": "/api/document/download/page?docId=A8rEBwtNbi8seR0&docVersionId=6tymxd&proxyType=S160" 
}

Attributes:

documentName
- Name of the updated document
documentId
- Id of the updated document
documentVersionId
- Id of the new version of the document
thumbUrl
- Thumb url to show a small preview of the first page of the document
crc32
- Cyclic redundancy check of the new version of document

DocumentVersionDeleteActivity

Is created when a document version is deleted.

Example:

{ 
"type":"com.netsas.activity.document.DocumentVersionNewActivity",
"id": "9223370678084205837_758703409",
"from": "mymail@mycompany.com",
"date": 1358784315477,
"read": true,
"documentName": "myNewDoc.doc",
"documentId": "A8rEBwtNbi8seR0",
"documentVersionId": "6tymxd"
}

Attributes:

documentName
- Name of the updated document
documentId
- Id of the updated document
documentVersionId
- Id of the new version of the document