l.s.v.i.l.ILoginTokenSet(Interface) : interface documentation

Part of lp.services.verification.interfaces.logintoken View In Hierarchy

The set of LoginTokens.
Attribute title Title
Method get Return the LoginToken object with the given id.
Method searchByEmailRequesterAndType Return all LoginTokens for the given email, requester and type.
Method deleteByEmailRequesterAndType Delete all LoginToken entries with the given email, requester and
Method searchByFingerprintRequesterAndType Return all LoginTokens for the given fingerprint, requester and
Method deleteByFingerprintRequesterAndType Delete all LoginToken entries with the given fingerprint,
Method getPendingGPGKeys Return tokens for OpenPGP keys pending validation, optionally for
Method new Create a new LoginToken object. Parameters must be:
Method __getitem__ Returns the LoginToken with the given id.
title =
Title
def get(id, default=None):
Return the LoginToken object with the given id.

Return the default value if there's no such LoginToken.

def searchByEmailRequesterAndType(email, requester, type, consumed=None):
Return all LoginTokens for the given email, requester and type.
ParametersemailThe email address to search for.
requesterThe Person object representing the requester to search for.
typeThe LoginTokenType to search for.
consumedA flag indicating whether to return consumed tokens. If False, only unconsumed tokens will be returned. If True, only consumed tokens will be returned. If None, this parameter will be ignored and all tokens will be returned.
def deleteByEmailRequesterAndType(email, requester, type):
Delete all LoginToken entries with the given email, requester and type.
def searchByFingerprintRequesterAndType(fingerprint, requester, type, consumed=None):
Return all LoginTokens for the given fingerprint, requester and type.
ParametersfingerprintThe LoginToken fingerprint to search for.
requesterThe Person object representing the requester to search for.
typeThe LoginTokenType to search for.
consumedA flag indicating whether to return consumed tokens. If False, only unconsumed tokens will be returned. If True, only consumed tokens will be returned. If None, this parameter will be ignored and all tokens will be returned.
def deleteByFingerprintRequesterAndType(fingerprint, requester, type):
Delete all LoginToken entries with the given fingerprint, requester and type.
def getPendingGPGKeys(requesterid=None):
Return tokens for OpenPGP keys pending validation, optionally for a single user.
def new(requester, requesteremail, email, tokentype, fingerprint=None, redirection_url=None):
Create a new LoginToken object. Parameters must be: requester: a Person object or None (in case of a new account)

requesteremail: the email address used to login on the system. Can
also be None in case of a new account

email: the email address that this request will be sent to. It should be previously validated by valid_email()

tokentype: the type of the request, according to LoginTokenType.

fingerprint: The OpenPGP key fingerprint used to retrieve key information from the key server if necessary. This can be None if not required to process the 'request' in question.

def __getitem__(id):
Returns the LoginToken with the given id.

Raises KeyError if there is no such LoginToken.

API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.