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
delete(Knock.Client.t(), String.t()) :: Knock.Api.response()
Issues a delete request against the user specified
Specs
get_channel_data(Knock.Client.t(), String.t(), String.t()) :: Knock.Api.response()
Returns user's channel data for the given channel id.
Specs
get_user(Knock.Client.t(), String.t()) :: Knock.Api.response()
Returns information about the user from the user_id
given.
Specs
identify(Knock.Client.t(), String.t(), map()) :: Knock.Api.response()
Sets the given properties on the user specified via the user_id
. Will perform
an upsert of the user.
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.