Skip to content

_lib_index_d_.rnappleauth.appleauthrequestresponsefullname.md

Latest commit

 

History

History
104 lines (64 loc) · 3.11 KB

_lib_index_d_.rnappleauth.appleauthrequestresponsefullname.md

File metadata and controls

104 lines (64 loc) · 3.11 KB

Interface: AppleAuthRequestResponseFullName

An optional full name shared by the user.

These fields are populated with values that the user authorized.

What is it?

The response object (responseObject.fullName) passed back from apple as the credential provider.

import appleAuth, {
  AppleAuthRequestOperation,
  AppleAuthRequestScope,
} from '@invertase/react-native-apple-authentication';

async function onPressAppleButton() {
  /**
   * responseObject may contain the following depending on the user's input when authenticating:
   * responseObject.fullName.familyName
   * responseObject.fullName.givenName
   * responseObject.fullName.middleName
   * responseObject.fullName.namePrefix
   * responseObject.fullName.nameSuffix
   * responseObject.fullName.nickname
   */

  const responseObject = await appleAuth.performRequest({
    requestedOperation: AppleAuthRequestOperation.LOGIN,
    requestedScopes: [AppleAuthRequestScope.EMAIL, AppleAuthRequestScope.FULL_NAME],
  });
}

Index

Properties

Properties

familyName

• familyName: string | null

Defined in lib/index.d.ts:258

Name passed from one generation to another to indicate lineage, e.g. Appleseed

givenName

• givenName: string | null

Defined in lib/index.d.ts:248

Name bestowed upon an individual by one's parents, e.g. Johnathan

middleName

• middleName: string | null

Defined in lib/index.d.ts:253

Secondary given name chosen to differentiate those with the same first name, e.g. Maple

namePrefix

• namePrefix: string | null

Defined in lib/index.d.ts:243

Pre-nominal letters denoting title, salutation, or honorific, e.g. Dr., Mr.

nameSuffix

• nameSuffix: string | null

Defined in lib/index.d.ts:263

Post-nominal letters denoting degree, accreditation, or other honor, e.g. Esq., Jr., Ph.D.

nickname

• nickname: string | null

Defined in lib/index.d.ts:268

Name substituted for the purposes of familiarity, e.g. "Johnny"