Módulo google.appengine.api.users

Resumo

A classe de armazenamento de dados do usuário Python a ser usada como um tipo de dados "armazenamento de dados".

Índice

google.appengine.api.users.CreateLoginURL(dest_url=None, _auth_domain=None, federated_identity=None)source

Calcula o URL de login para o redirecionamento.

Parâmetros

• dest_url: string que é o URL de destino final desejado para o usuário uma vez que o login for realizado. Se dest_url não especificar um host, o host da solicitação atual será usado.

• federated_identity: desativado, não use. Configurar com um valor diferente de "None" cria um erro NotAllowedError

Retorna

URL de login como uma string. O URL de login usará as Contas do Google.

Gera

NotAllowedError: se federated_identity não for None.

google.appengine.api.users.CreateLogoutURL(dest_url, _auth_domain=None)source

Calcula o URL de logout e o URL de destino especificado para a solicitação.

Essa função funciona com aplicativos de Contas do Google.

Parâmetros

dest_url: string que é o URL de destino final desejado para o usuário depois que o usuário sair da conta. Se dest_url não especificar um host, o host da solicitação atual será usado.

Retorna

URL de logout como uma string.

exception google.appengine.api.users.Errorsource

Bases: exceptions.Exception

Tipo de erro do usuário base.

google.appengine.api.users.GetCurrentUser()source

Recupera informações associadas ao usuário que está fazendo uma solicitação.

Retorna:

google.appengine.api.users.IsCurrentUserAdmin()source

Especifica se o usuário que está fazendo uma solicitação é um administrador de aplicativo.

Como o status do administrador não é persistente no armazenamento de dados, is_current_user_admin() é uma função separada e não faz parte da classe User. O status só existe para o usuário que faz a solicitação atual.

Retorna

True se o usuário for um administrador. Todos os demais tipos de usuários retornam False.

exception google.appengine.api.users.NotAllowedErrorsource

Bases: google.appengine.api.users.Error

O URL de redirecionamento solicitado não é permitido.

exception google.appengine.api.users.RedirectTooLongErrorsource

Bases: google.appengine.api.users.Error

O URL de redirecionamento gerado foi muito longo.

class google.appengine.api.users.User(email=None, _auth_domain=None, _user_id=None, federated_identity=None, federated_provider=None, _strict_mode=True)source

Bases: object

Fornece o endereço de e-mail, apelido e código de um usuário.

Um apelido é uma string legível que identifica de maneira exclusiva um usuário do Google, semelhante a um nome de usuário. Para alguns usuários, esse apelido é um endereço de e-mail, mas para outros um apelido diferente é usado.

O usuário é um usuário de Contas do Google.

federated_identity e federated_provider estão desativados e não devem ser usados.

auth_domain()source

Retorna o domínio de autenticação do usuário.

Retorna

Uma string que contém o domínio de autenticação. Esse método é interno e não deve ser usado por aplicativos cliente.

email()source

Retorna o endereço de e-mail do usuário.

federated_identity()source

Desativado, não use.

Retorna

Uma string que contém a identidade federada do usuário. Se o usuário não for um usuário federado, None é retornado.

federated_provider()source

Desativado, não use.

Retorna

Uma string que contém o provedor federado. Se o usuário não for um usuário federado, None é retornado.

nickname()source

Retorna o apelido do usuário.

O apelido será um identificador exclusivo e legível desse usuário no que diz respeito ao aplicativo. Será um endereço de e-mail para alguns usuários e parte do endereço de e-mail para outros.

Retorna

O apelido do usuário como uma string.

user_id()source

Retorna o User ID do usuário.

Retorna

Uma string de identificação única permanente ou None. Se o endereço de e-mail foi definido explicitamente, retornará None.

exception google.appengine.api.users.UserNotFoundErrorsource

Bases: google.appengine.api.users.Error

Nenhum argumento de e-mail foi especificado e nenhum usuário fez login.

google.appengine.api.users.create_login_url(dest_url=None, _auth_domain=None, federated_identity=None)source

Calcula o URL de login para o redirecionamento.

Parâmetros

• dest_url: string que é o URL de destino final desejado para o usuário uma vez que o login for realizado. Se dest_url não especificar um host, o host da solicitação atual será usado.

• federated_identity: desativado, não use. Configurar com um valor diferente de "None" cria um erro NotAllowedError

Retorna

URL de login como uma string. O URL de login usará as Contas do Google.

Gera

NotAllowedError: se federated_identity não for None.

google.appengine.api.users.create_logout_url(dest_url, _auth_domain=None)source

Calcula o URL de logout e o URL de destino especificado para a solicitação.

Essa função funciona com aplicativos de Contas do Google.

Parâmetros

dest_url: string que é o URL de destino final desejado para o usuário depois que o usuário sair da conta. Se dest_url não especificar um host, o host da solicitação atual será usado.

Retorna

URL de logout como uma string.

google.appengine.api.users.get_current_user()source

Recupera informações associadas ao usuário que está fazendo uma solicitação.

Retorna:

google.appengine.api.users.is_current_user_admin()source

Especifica se o usuário que está fazendo uma solicitação é um administrador de aplicativo.

Como o status do administrador não é persistente no armazenamento de dados, is_current_user_admin() é uma função separada e não faz parte da classe User. O status só existe para o usuário que faz a solicitação atual.

Retorna

True se o usuário for um administrador. Todos os demais tipos de usuários retornam False.