Deputy.Constants.Roster (Deputy v0.5.0)

Copy Markdown View Source

Integer codes used in roster publishing and management.

Examples

iex> Deputy.Constants.Roster.publish_mode_notify()
1

iex> Deputy.Constants.Roster.publish_mode_silent()
2

iex> import Deputy.Constants.Roster
iex> is_publish_mode_notify(1)
true

Summary

Functions

All locations mode enabled (blnAllLocationsMode: 1)

Guard: matches the all-locations flag (1).

Guard: matches the publish-and-notify mode (1).

Guard: matches the publish-without-notification mode (2).

Guard: matches the single-location flag (0).

Publish and notify employees (intMode: 1)

Publish without notification (intMode: 2)

All locations mode disabled (blnAllLocationsMode: 0)

Functions

all_locations()

All locations mode enabled (blnAllLocationsMode: 1)

is_all_locations(value)

(macro)

Guard: matches the all-locations flag (1).

is_publish_mode_notify(value)

(macro)

Guard: matches the publish-and-notify mode (1).

is_publish_mode_silent(value)

(macro)

Guard: matches the publish-without-notification mode (2).

is_single_location(value)

(macro)

Guard: matches the single-location flag (0).

publish_mode_notify()

Publish and notify employees (intMode: 1)

publish_mode_silent()

Publish without notification (intMode: 2)

single_location()

All locations mode disabled (blnAllLocationsMode: 0)