@refinio/one.models
Preparing search index...
models/AccessModel
default
Class default
Deprecated
Description
Access Model class
Hierarchy (
View Summary
)
Model
default
Index
Constructors
constructor
Properties
on
Groups
Updated
on
Updated
state
Methods
add
Person
To
Access
Group
create
Access
Group
get
Access
Group
By
Name
get
Access
Group
Persons
give
Group
Access
To
Object
init
remove
Person
From
Access
Group
shutdown
Constructors
constructor
new
default
()
:
default
Returns
default
Properties
on
Groups
Updated
onGroupsUpdated
:
OEvent
<
()
=>
void
>
= ...
Event is emitted when:
a access group is created
persons are added to the access group
persons are removed from the access group
on
Updated
onUpdated
:
OEvent
<
()
=>
void
>
= ...
state
state
:
StateMachine
<
"Uninitialised"
|
"Initialised"
,
"shutdown"
|
"init"
>
Methods
add
Person
To
Access
Group
addPersonToAccessGroup
(
name
:
string
,
personId
:
SHA256IdHash
<
Person
>
,
)
:
Promise
<
void
>
Parameters
name
:
string
personId
:
SHA256IdHash
<
Person
>
Returns
Promise
<
void
>
create
Access
Group
createAccessGroup
(
name
:
string
)
:
Promise
<
void
>
Parameters
name
:
string
Returns
Promise
<
void
>
get
Access
Group
By
Name
getAccessGroupByName
(
name
:
string
)
:
Promise
<
VersionedObjectResult
<
Group
>
>
Parameters
name
:
string
Returns
Promise
<
VersionedObjectResult
<
Group
>
>
get
Access
Group
Persons
getAccessGroupPersons
(
groupName
:
string
|
string
[]
,
)
:
Promise
<
SHA256IdHash
<
Person
>
[]
>
Parameters
groupName
:
string
|
string
[]
Returns
Promise
<
SHA256IdHash
<
Person
>
[]
>
give
Group
Access
To
Object
giveGroupAccessToObject
(
groupName
:
string
,
objectHash
:
SHA256Hash
<
OneObjectTypes
>
,
)
:
Promise
<
VersionedObjectResult
<
Access
|
IdAccess
>
>
Parameters
groupName
:
string
objectHash
:
SHA256Hash
<
OneObjectTypes
>
Returns
Promise
<
VersionedObjectResult
<
Access
|
IdAccess
>
>
init
init
()
:
Promise
<
void
>
Returns
Promise
<
void
>
remove
Person
From
Access
Group
removePersonFromAccessGroup
(
name
:
string
,
personId
:
SHA256IdHash
<
Person
>
,
)
:
Promise
<
void
>
Parameters
name
:
string
personId
:
SHA256IdHash
<
Person
>
Returns
Promise
<
void
>
shutdown
shutdown
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
on
Groups
Updated
on
Updated
state
Methods
add
Person
To
Access
Group
create
Access
Group
get
Access
Group
By
Name
get
Access
Group
Persons
give
Group
Access
To
Object
init
remove
Person
From
Access
Group
shutdown
@refinio/one.models
Loading...
Deprecated
Description
Access Model class