DndFacet

Kind: global class

• DndFacet
  • .endDnd([optCb])
  • .endSnooze([optCb])
  • .info([opts], [optCb])
  • .setSnooze(num_minutes, [optCb])
  • .teamInfo([opts], [optCb])

dndFacet.endDnd([optCb])

Ends the current user’s Do Not Disturb session immediately.

Kind: instance method of [DndFacet](#DndFacet)
See: dnd.endDnd

Param	Type	Description
[optCb]	function	Optional callback, if not using promises.

dndFacet.endSnooze([optCb])

Ends the current user’s snooze mode immediately.

Kind: instance method of [DndFacet](#DndFacet)
See: dnd.endSnooze

Param	Type	Description
[optCb]	function	Optional callback, if not using promises.

dndFacet.info([opts], [optCb])

Retrieves a user’s current Do Not Disturb status.

Kind: instance method of [DndFacet](#DndFacet)
See: dnd.info

Param	Type	Description
[opts]	Object
opts.user	?	User to fetch status for (defaults to current user)
[optCb]	function	Optional callback, if not using promises.

dndFacet.setSnooze(num_minutes, [optCb])

Turns on Do Not Disturb mode for the current user, or changes its duration.

Kind: instance method of [DndFacet](#DndFacet)
See: dnd.setSnooze

Param	Type	Description
num_minutes	?	Number of minutes, from now, to snooze until.
[optCb]	function	Optional callback, if not using promises.

dndFacet.teamInfo([opts], [optCb])

Retrieves the Do Not Disturb status for users on a team.

Kind: instance method of [DndFacet](#DndFacet)
See: dnd.teamInfo

Param	Type	Description
[opts]	Object
opts.users	?	Comma-separated list of users to fetch Do Not Disturb status for
[optCb]	function	Optional callback, if not using promises.