c.l.i.a.IAccountPublic(Interface) : interface documentation

Part of canonical.launchpad.interfaces.account View In Hierarchy

Known subclasses: canonical.launchpad.interfaces.account.IAccount

Public information on an IAccount.
Int id Undocumented
StrippedTextLine displayname Your name as you would like it displayed.
Choice status Undocumented
Bool is_valid Undocumented
Method setPreferredEmail Set the given email address as this account's preferred one.
Method validateAndEnsurePreferredEmail Ensure this account has a preferred email.
id =
Undocumented
displayname =
Your name as you would like it displayed.
status =
Undocumented
is_valid =
Undocumented
def setPreferredEmail(email):
Set the given email address as this account's preferred one.

If email is None, the preferred email address is unset, which will make the account invalid.

def validateAndEnsurePreferredEmail(email):
Ensure this account has a preferred email.

If this account doesn't have a preferred email, <email> will be set as this account's preferred one. Otherwise it'll be set as VALIDATED and this account will keep their old preferred email.

This method is meant to be the only one to change the status of an email address, but as we all know the real world is far from ideal and we have to deal with this in one more place, which is the case when people explicitly want to change their preferred email address. On that case, though, all we have to do is use account.setPreferredEmail().

API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.