Knock.Preferences (Knock v0.4.14) View Source

Knock resources for accessing preferences. Note: this module and all of the functions here are deprecated and will be removed in the next version.

Link to this section Summary

Functions

get(client, user_id, options \\ []) deprecated

Returns the preference set for the user

get_all(client, user_id) deprecated

Returns all of the users preference sets

set(client, user_id, preferences, options \\ []) deprecated

Sets the entire preference set for the user

set_categories(client, user_id, categories, options \\ []) deprecated

Sets the workflow preferences for the user

set_category(client, user_id, category_key, setting, options \\ []) deprecated

Sets the workflow preference for the user

set_channel_type(client, user_id, channel_type, setting, options \\ []) deprecated

Sets the channel type preferences for the user

set_channel_types(client, user_id, channel_types, options \\ []) deprecated

Sets the channel type preferences for the user

set_workflow(client, user_id, workflow_key, setting, options \\ []) deprecated

Sets the workflow preference for the user

set_workflows(client, user_id, workflows, options \\ []) deprecated

Sets the workflow preferences for the user

Link to this section Functions

get(client, user_id, options \\ [])

This function is deprecated. Use Users.get_preferences/3 instead.

Returns the preference set for the user

get_all(client, user_id)

This function is deprecated. Use Users.get_all_preferences/2 instead.

Returns all of the users preference sets

set(client, user_id, preferences, options \\ [])

This function is deprecated. Use Users.set_preferences/4 instead.

Sets the entire preference set for the user

set_categories(client, user_id, categories, options \\ [])

This function is deprecated. Use Users.set_categories_preferences/4 instead.

Sets the workflow preferences for the user

set_category(client, user_id, category_key, setting, options \\ [])

This function is deprecated. Use Users.set_category_preferences/5 instead.

Sets the workflow preference for the user

set_channel_type(client, user_id, channel_type, setting, options \\ [])

This function is deprecated. Use Users.set_channel_type_preferences/5 instead.

Sets the channel type preferences for the user

set_channel_types(client, user_id, channel_types, options \\ [])

This function is deprecated. Use Users.set_channel_types_preferences/4 instead.

Sets the channel type preferences for the user

set_workflow(client, user_id, workflow_key, setting, options \\ [])

This function is deprecated. Use Users.set_workflow_preferences/5 instead.

Sets the workflow preference for the user

set_workflows(client, user_id, workflows, options \\ [])

This function is deprecated. Use Users.set_workflows_preferences/4 instead.

Sets the workflow preferences for the user