Skip to main content
Version: 10 - Vanillekipferl

RecordUser

class flow_api.record_user.RecordUser(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, is_pinned=<class 'flow_api.system.NotSet'>, record_id=<class 'flow_api.system.NotSet'>, user_id=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Row

Mapping a record to a user. Used for showing items in the sidebar.

Parameters

NameTypeDescription
allow_deletedbool
allow_normalbool
bystr
clstyping.Union[ type, NoneType ]
commitbool
debugboolif set, the content of the data being written will be logged.
inittyping.Union[ dict, NoneType ]
is_pinnedtyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the record is already pinned by the user.
record_idtyping.Union[ flow_api.system.NotSet, str ]Reference to the record whom the user is mapped to.
selecttyping.Union[ str, NoneType ]
user_idtyping.Union[ flow_api.system.NotSet, str ]Reference to the user whom the record is mapped to.

Constants

RESOURCE = record_user

Methods

clone

delete

exists

export

get

get_dict

record

restore

save

user