Browse Source

add documentation for generic invitations (#535)

merge-stacks-repo-docs
Friedger Müffke 5 years ago
committed by GitHub
parent
commit
b241e2c815
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 22
      _develop/radiks-collaborate.md

22
_develop/radiks-collaborate.md

@ -71,16 +71,34 @@ const invitation = await group.makeGroupMembership(usernameToInvite);
console.log(invitation._id); // the ID used to later activate an invitation console.log(invitation._id); // the ID used to later activate an invitation
``` ```
#### Generic invitation
You can also create a generic invitation that any user can activate, if they are provided with randomly generated secret key, which should be used to decrypt the invitation. The key is generated when the generic invitation is being created.
~~~javascript
import { GenericGroupInvitation, UserGroup } from 'radiks';
const group = await UserGroup.findById(myGroupId);
// Creating generic invitation
const genericInvitation = await GenericGroupInvitation.makeGenericInvitation(group);
console.log(genericInvitation._id); // the ID used to later activate an invitation
console.log(genericInvitation.secretCode); // the secretCode used to later activate an invitation
~~~
### Accept an invitation ### Accept an invitation
Use the `activate` method on a `GroupInvitation` instance to activate an invitation on behalf of a user: Use the `activate` method on a `GroupInvitation` instance to activate an invitation on behalf of a user:
```javascript ```javascript
import { GroupInvitation } from 'radiks'; import { GroupInvitation, GenericGroupInvitation } from 'radiks';
// For user-specific invitation
const invitation = await GroupInvitation.findById(myInvitationID); const invitation = await GroupInvitation.findById(myInvitationID);
await invitation.activate(); await invitation.activate();
```
// For generic invitation
const genericInvitation = await GenericGroupInvitation.findById(myInvitationID);
await genericInvitation.activate(mySecretCode);```
## View all activated UserGroups for the current user ## View all activated UserGroups for the current user

Loading…
Cancel
Save