UrbitEx.API.Profile (UrbitEx v0.6.6) View Source

Client API to interact with the contacts-store of your Urbit Ship. Includes functions to change your Urbit profile.

Link to this section Summary

Functions

Adds a pinned group to your public profile. Takes a Session struct, a Channel struct, and a Resource struct of the group to apply.

Sets your public as public or private. Takes a Session struct, a Channel struct, and a boolean, true for public.

Sets your public status. Takes a Session struct, a Channel struct, and the string to apply.

Sets your avatar picture. Takes a Session struct, a Channel struct, and a url string to apply.

Sets your public bio. Takes a Session struct, a Channel struct, and the string to apply.

Sets your cover picture. Takes a Session struct, a Channel struct, and a url string to apply.

Sets your public nickname. Takes a Session struct, a Channel struct, and the string to apply.

Sets your sigil color. Takes a Session struct, a Channel struct, and the color hex code string to apply.

Link to this section Functions

Link to this function

add_pinned_group(session, channel, resource)

View Source

Adds a pinned group to your public profile. Takes a Session struct, a Channel struct, and a Resource struct of the group to apply.

Link to this function

make_profile_public(session, channel, boolean)

View Source

Sets your public as public or private. Takes a Session struct, a Channel struct, and a boolean, true for public.

Link to this function

set_status(session, channel, status)

View Source

Sets your public status. Takes a Session struct, a Channel struct, and the string to apply.

Link to this function

update_avatar(session, channel, url)

View Source

Sets your avatar picture. Takes a Session struct, a Channel struct, and a url string to apply.

Link to this function

update_bio(session, channel, string)

View Source

Sets your public bio. Takes a Session struct, a Channel struct, and the string to apply.

Link to this function

update_cover(session, channel, url)

View Source

Sets your cover picture. Takes a Session struct, a Channel struct, and a url string to apply.

Link to this function

update_nickname(session, channel, string)

View Source

Sets your public nickname. Takes a Session struct, a Channel struct, and the string to apply.

Link to this function

update_sigil_color(session, channel, hex_code)

View Source

Sets your sigil color. Takes a Session struct, a Channel struct, and the color hex code string to apply.