PhoneNumberTokenProvider<TUser, TKey> Class

 

Represents a token provider that generates tokens from the user's security stamp and notifies a user via their phone number.

Namespace:   Microsoft.AspNet.Identity
Assembly:  Microsoft.AspNet.Identity.Core (in Microsoft.AspNet.Identity.Core.dll)

Inheritance Hierarchy

System.Object
  Microsoft.AspNet.Identity.TotpSecurityStampBasedTokenProvider<TUser, TKey>
    Microsoft.AspNet.Identity.PhoneNumberTokenProvider<TUser, TKey>
      Microsoft.AspNet.Identity.PhoneNumberTokenProvider<TUser>

Syntax

public class PhoneNumberTokenProvider<TUser, TKey> : TotpSecurityStampBasedTokenProvider<TUser, TKey>
where TUser : class, IUser<TKey>
where TKey : object, IEquatable<TKey>
generic<typename TUser, typename TKey>
where TUser : ref class, IUser<TKey>
where TKey : Object, IEquatable<TKey>
public ref class PhoneNumberTokenProvider : TotpSecurityStampBasedTokenProvider<TUser, TKey>
type PhoneNumberTokenProvider<'TUser, 'TKey when 'TUser : not struct and IUser<'TKey> when 'TKey : Object and IEquatable<'TKey>> = 
    class
        inherit TotpSecurityStampBasedTokenProvider<'TUser, 'TKey>
    end
Public Class PhoneNumberTokenProvider(Of TUser As { Class, IUser(Of TKey) }, TKey As { Object, IEquatable(Of TKey) })
    Inherits TotpSecurityStampBasedTokenProvider(Of TUser, TKey)

Type Parameters

  • TUser
    The type of the user.
  • TKey
    The type of the keys.

Constructors

Name Description
System_CAPS_pubmethod PhoneNumberTokenProvider<TUser, TKey>()

Initializes a new instance of the PhoneNumberTokenProvider<TUser, TKey> class.

Properties

Name Description
System_CAPS_pubproperty MessageFormat

Gets or sets the message contents which should contain a format string which the token will be the only argument.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GenerateAsync(String, UserManager<TUser, TKey>, TUser)

Asynchronously generates a token for the user using their security stamp.(Inherited from TotpSecurityStampBasedTokenProvider<TUser, TKey>.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod GetUserModifierAsync(String, UserManager<TUser, TKey>, TUser)

Asynchronously returns the phone number of the user for entropy in the token.(Overrides TotpSecurityStampBasedTokenProvider<TUser, TKey>.GetUserModifierAsync(String, UserManager<TUser, TKey>, TUser).)

System_CAPS_pubmethod IsValidProviderForUserAsync(UserManager<TUser, TKey>, TUser)

Asynchronously determines whether the user has a phone number set.(Overrides TotpSecurityStampBasedTokenProvider<TUser, TKey>.IsValidProviderForUserAsync(UserManager<TUser, TKey>, TUser).)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod NotifyAsync(String, UserManager<TUser, TKey>, TUser)

Asynchronously notifies the user with a token via SMS using the MessageFormat.(Overrides TotpSecurityStampBasedTokenProvider<TUser, TKey>.NotifyAsync(String, UserManager<TUser, TKey>, TUser).)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod ValidateAsync(String, String, UserManager<TUser, TKey>, TUser)

Asynchronously validates the token for the user.(Inherited from TotpSecurityStampBasedTokenProvider<TUser, TKey>.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.AspNet.Identity Namespace
ASP.NET Identity

Return to top