External module "social"

Index

Functions

Functions

Const attachFiles

attachFiles(flowKey: string, formData: FormData, onProgress: EventListenerOrEventListenerObject): JQueryXHR

- Defined in social.ts:198
Upload a file to the stream via Ajax.uploadSocialFile

Parameters
- flowKey: string
- formData: FormData
- onProgress: EventListenerOrEventListenerObject
Returns JQueryXHR

Const getMessages

getMessages(flowKey: string): Promise3<void, never, never, never, never, never, never, never, never>

- Defined in social.ts:76
Get the messages for this stream via Ajax.getSocialMessages then display them in the feed

Parameters
- flowKey: string
Returns Promise3<void, never, never, never, never, never, never, never, never>

Const getStream

getStream(flowKey: string): any

- Defined in social.ts:45
Get the currently active stream

Parameters
- flowKey: string
Returns any

Const getUsers

getUsers(flowKey: string, name?: string): JQueryXHR

- Defined in social.ts:184
Get the users for this stream via Ajax.getUsers, optionally filter by a specific name

Parameters
- flowKey: string
- Optional name: string
Returns JQueryXHR

Const initialize

initialize(flowKey: string, streamId: string): Promise3<void, never, never, never, never, never, never, never, never>

- Defined in social.ts:13
Initialize the social stream by requesting Ajax.getSocialMe then Ajax.getSocialMessages, then render the feed

Parameters
- flowKey: string
- streamId: string
Returns Promise3<void, never, never, never, never, never, never, never, never>

Const refreshMessages

refreshMessages(flowKey: string): Promise3<void, never, never, never, never, never, never, never, never>

- Defined in social.ts:53
Refresh the current page of messages via Ajax.getSocialMessages then display them in the feed

Parameters
- flowKey: string
Returns Promise3<void, never, never, never, never, never, never, never, never>

Const remove

remove(flowKey: string): void

- Defined in social.ts:211
Remove locally cached data on the social stream for this state

Parameters
- flowKey: string
Returns void

Const sendMessage

sendMessage(flowKey: string, message: string, repliedTo: string, mentionedUsers: any, attachments: any): Promise3<void, never, never, never, never, never, never, never, never>

- Defined in social.ts:105
Send a message to the social stream

Parameters
- flowKey: string
- message: string
  
  Message content
- repliedTo: string
  
  Id of the message thats being replied to (optional)
- mentionedUsers: any
  
  @ mentioned users
- attachments: any
  
  Files to be uploaded as part of the message
Returns Promise3<void, never, never, never, never, never, never, never, never>

Const toggleFollow

toggleFollow(flowKey: string): Promise3<void, never, never, never, never, never, never, never, never>

- Defined in social.ts:158
Display the loading indicator in the social feed, toggle follow status with Ajax.follow then re-render

Parameters
- flowKey: string
Returns Promise3<void, never, never, never, never, never, never, never, never>

Generated using TypeDoc