l.r.i.s.ISSHKeySet(Interface) : interface documentation

Part of lp.registry.interfaces.ssh View In Hierarchy

The set of SSHKeys.
Method new Create a new SSHKey pointing to the given Person.
Method getByID Return the SSHKey object for the given id.
Method getByPeople Return SSHKey object associated to the people provided.
Method getByPersonAndKeyText Get an SSH key for a person with a specific key text.
def new(person, sshkey, check_key=True, send_notification=True, dry_run=False):
Create a new SSHKey pointing to the given Person.
ParameterspersonThe IPerson to add the ssh key to.
sshkeyThe full ssh key text.
check_keySet to False to skip the check for whether the key text can be deserialised by Twisted.
send_notificationSet to False to suppress sending the user an email about the change.
dry_runPerform all the format checks, but don't actually add the key. Causes the method to return None, rather than an instance of ISSHKey.
def getByID(id, default=None):
Return the SSHKey object for the given id.

Return the given default if there's now object with the given id.

def getByPeople(people):
Return SSHKey object associated to the people provided.
def getByPersonAndKeyText(person, sshkey):
Get an SSH key for a person with a specific key text.
ParameterspersonThe person who owns the key.
sshkeyThe full ssh key text.
RaisesSSHKeyAdditionErrorIf 'sshkey' is invalid.
API Documentation for Launchpad, generated by pydoctor at 2019-07-23 00:00:05.