status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixing the class names of the permission classes (#1894)

This commit is contained in:
Kenneth Geisshirt 2018-06-27 09:14:29 +02:00 committed by GitHub
parent e46bd3899b
commit 77026c7a19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -19,6 +19,7 @@ X.Y.Z Release notes
### Internals ### Internals
* Upgraded to Realm Core v5.6.3. * Upgraded to Realm Core v5.6.3.
* Upgraded to Realm Sync v3.5.8. * Upgraded to Realm Sync v3.5.8.
* Fixed class names in API documentation.
2.10.0 Release notes (2018-6-19) 2.10.0 Release notes (2018-6-19)

18
docs/permission.js
View File

@ -243,7 +243,7 @@ class PermissionOfferResponse {
* the properties of Permission depend on what the permission is applied to, and so are * the properties of Permission depend on what the permission is applied to, and so are
* left undocumented here. * left undocumented here.
* @since 2.3.0 * @since 2.3.0
* @memberof Realm.Sync * @memberof Realm.Permissions
*/ */
class Permission { class Permission {
@ -253,7 +253,7 @@ class Permission {
* objects/classes/realms which use this Permission. * objects/classes/realms which use this Permission.
* *
* This property cannot be modified once set. * This property cannot be modified once set.
* @type {Role} * @type {Realm.Permissions.Role}
*/ */
get role() {} get role() {}
@ -321,7 +321,7 @@ class Permission {
* a Realm, and can also be created manually if you wish to grant permissions to a user * a Realm, and can also be created manually if you wish to grant permissions to a user
* which has not yet connected to this Realm. * which has not yet connected to this Realm.
* @since 2.3.0 * @since 2.3.0
* @memberof Realm.Sync.Permission * @memberof Realm.Permissions
*/ */
class User { class User {
/** /**
@ -342,7 +342,7 @@ class User {
* connect to the Realm are automatically added to it. Any other roles you wish to use are * connect to the Realm are automatically added to it. Any other roles you wish to use are
* managed as normal Realm objects. * managed as normal Realm objects.
* @since 2.3.0 * @since 2.3.0
* @memberof Realm.Sync.Permission * @memberof Realm.Permissions
*/ */
class Role { class Role {
/** /**
@ -353,7 +353,7 @@ class Role {
/** /**
* The users which belong to the role. * The users which belong to the role.
* @type {Array<Realm.Sync.Permissions.User>} * @type {Array<Realm.Permissions.User>}
*/ */
get members() {} get members() {}
} }
@ -364,7 +364,7 @@ class Role {
* An instance of this object is automatically created in the Realm for class in your schema, * An instance of this object is automatically created in the Realm for class in your schema,
* and should not be created manually. * and should not be created manually.
* @since 2.3.0 * @since 2.3.0
* @memberof Realm.Sync.Permission * @memberof Realm.Permissions
*/ */
class Class { class Class {
/** /**
@ -375,7 +375,7 @@ class Class {
/** /**
* The permissions for this class. * The permissions for this class.
* @type {Array<Realm.Sync.Permissions.Permission>} * @type {Array<Realm.Permissions.Permission>}
*/ */
get permissions() {} get permissions() {}
} }
@ -386,12 +386,12 @@ class Class {
* An object of this type is automatically created in the Realm for you, and more objects * An object of this type is automatically created in the Realm for you, and more objects
* cannot be created manually. * cannot be created manually.
* @since 2.3.0 * @since 2.3.0
* @memberof Realm.Sync.Permission * @memberof Realm.Permissions
*/ */
class Realm { class Realm {
/** /**
* The permissions for the Realm. * The permissions for the Realm.
* @type {Array<Realm.Sync.Permission>} * @type {Array<Realm.Permissions.Permission>}
*/ */
get permissions() {} get permissions() {}
} }