Sharelink

class labstep.entities.sharelink.model.Sharelink(data, user)

Represents a Sharelink on Labstep.

edit(permission=OPTIONAL, extraParams={})

Edit a sharelink.

Parameters:: permission (str) – Set the permission granted by the sharelink can be either ‘view’ or ‘edit’
Returns:: An object representing the edited Sharelink.
Return type:: Sharelink

Example

# Get an experiment
experiment = user.getExperiment(123)

# Get the sharelink for the experiment
sharelink = experiment.getSharelink()

# Edit the sharelink
sharelink.edit(type='view')

sendEmails(emails, message=OPTIONAL)

Send sharelinks to collaborators via email.

Parameters:

emails (list) – A list of the emails to send the invite to.
message (str) – A message to send with the invite.

Example

sharelink.sendEmails(emails=['collegue1@labstep.com','collegue2@labstep.com'],
    message='Hi, please collaborate with me on Labstep!')