Knock.Users (Knock v0.3.0) View Source

Knock resources for accessing users

Link to this section Summary

Functions

Issues a delete request against the user specified

Returns user's channel data for the given channel id.

Returns information about the user from the user_id given.

Sets the given properties on the user specified via the user_id. Will perform an upsert of the user.

Upserts user's channel data for the given channel id.

Link to this section Functions

Specs

Issues a delete request against the user specified

Link to this function

get_channel_data(client, user_id, channel_id)

View Source

Specs

get_channel_data(Knock.Client.t(), String.t(), String.t()) ::
  Knock.Api.response()

Returns user's channel data for the given channel id.

Link to this function

get_user(client, user_id)

View Source

Specs

Returns information about the user from the user_id given.

Link to this function

identify(client, user_id, properties)

View Source

Specs

Sets the given properties on the user specified via the user_id. Will perform an upsert of the user.

Link to this function

set_channel_data(client, user_id, channel_id, channel_data)

View Source

Specs

set_channel_data(Knock.Client.t(), String.t(), String.t(), map()) ::
  Knock.Api.response()

Upserts user's channel data for the given channel id.