l.s.i.a.IArchiveAuthTokenSet(Interface) : interface documentation

Part of lp.soyuz.interfaces.archiveauthtoken View In Hierarchy

An interface for ArchiveAuthTokenSet.
Method get Retrieve a token by its database ID.
Method getByToken Retrieve a token by its token text.
Method getByArchive Retrieve all the tokens for an archive.
Method getActiveTokenForArchiveAndPerson Retrieve an active token for the given archive and person.
Method getActiveNamedTokenForArchive Retrieve an active named token for the given archive and name.
Method getActiveNamedTokensForArchive Retrieve a subset of active named tokens for the given archive if
Method deactivateNamedTokensForArchive Deactivate named tokens for the given archive.
def get(token_id):
Retrieve a token by its database ID.
Parameterstoken_idThe database ID.
ReturnsAn object conforming to IArchiveAuthToken.
def getByToken(token):
Retrieve a token by its token text.
ParameterstokenThe token text for the token.
ReturnsAn object conforming to IArchiveAuthToken.
def getByArchive(archive):
Retrieve all the tokens for an archive.

:param archive: The context archive.
:return: A result set containing `IArchiveAuthToken`s.
def getActiveTokenForArchiveAndPerson(archive, person):
Retrieve an active token for the given archive and person.
ParametersarchiveThe archive to which the token corresponds.
personThe person to which the token corresponds.
ReturnsAn IArchiveAuthToken or None.
def getActiveNamedTokenForArchive(archive, name):
Retrieve an active named token for the given archive and name.

:param archive: The archive to which the token corresponds.
:param name: The name of a named authorization token.
:return An object conforming to `IArchiveAuthToken` or None.
def getActiveNamedTokensForArchive(archive, names=None):
Retrieve a subset of active named tokens for the given archive if
`names` is specified, or all active named tokens for the archive if
`names` is null.

:param archive: The archive to which the tokens correspond.
:param names: An optional list of token names.
:return: A result set containing `IArchiveAuthToken`s.
def deactivateNamedTokensForArchive(archive, names):
Deactivate named tokens for the given archive.
ParametersarchiveThe archive to which the tokens correspond.
namesA list of token names.
API Documentation for Launchpad, generated by pydoctor at 2020-07-11 00:00:15.