Class ClaimedAccount

Account that has been claimed by the user after Search.

Hierarchy

AutoSearchAccount
- ClaimedAccount

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ClaimedAccount(site: Site, userName: string, idPrefix?: string): ClaimedAccount

Inherited from AutoSearchAccount.constructor
- Defined in search/accounts.ts:193
Parameters
- site: Site
- userName: string
- Optional idPrefix: string
Returns ClaimedAccount

Properties

actionTaken

actionTaken: AutoSearchAccountAction = ...

claimedAt

claimedAt: Date = ...

createdAt

createdAt: Date = ...

id

id: string

matchedFirstNames

matchedFirstNames: string[] = ...

matchedLastNames

matchedLastNames: string[] = ...

matchedUserName

matchedUserName: boolean = false

rev

rev: string = ''

site

site: Site

type

type: AccountType = ...

userName

userName: string

Static accountCache

accountCache: DbCache<ThirdPartyAccount> = ...

Static resultCache

resultCache: DbCache<ThirdPartyAccount> = ...

Accessors

confidence

get confidence(): ConfidenceRating

- Defined in search/accounts.ts:305
Returns ConfidenceRating

url

get url(): string

- Defined in search/accounts.ts:191
Returns string

Static accounts

get accounts(): {}

- Defined in search/accounts.ts:448
Map of accounts that are an instance of this class.

Returns {}
- [key: string]: T

Static results

get results(): {}

- Defined in search/accounts.ts:452
Map of results that are an instance of this class.

Returns {}
- [key: string]: T

Methods

claim

claim(): Promise<ClaimedAccount>

Inherited from AutoSearchAccount.claim
- Defined in search/accounts.ts:326
Return a claimed version of this account.

TODO: This is a little unstable

Returns Promise<ClaimedAccount>

reject

reject(): Promise<RejectedAccount>

Inherited from AutoSearchAccount.reject
- Defined in search/accounts.ts:366
Return a rejected version of this account.

TODO: This is a little unstable

Returns Promise<RejectedAccount>

remove

remove(): Promise<void>

Inherited from AutoSearchAccount.remove
- Defined in search/accounts.ts:231
Returns Promise<void>

save

save(): Promise<Response>

Inherited from AutoSearchAccount.save
- Defined in search/accounts.ts:209
Save/update this account in the database.

Don't call this unless you've made changes! Each call will create a revision and take up space.

Returns Promise<Response>

serialize

serialize(): ClaimedAccountSchema

Overrides AutoSearchAccount.serialize
- Defined in search/accounts.ts:471
Returns ClaimedAccountSchema

Static deserialize

deserialize(data: ClaimedAccountSchema, existingInstance?: ClaimedAccount): Promise<ClaimedAccount>

Overrides AutoSearchAccount.deserialize
- Defined in search/accounts.ts:456
Parameters
- data: ClaimedAccountSchema
- Optional existingInstance: ClaimedAccount
Returns Promise<ClaimedAccount>

Static factory

factory(data: AccountSchema): Promise<ThirdPartyAccount>

Inherited from AutoSearchAccount.factory
- Defined in search/accounts.ts:45
Factory method for creating an account using the appropriate subclass.

Parameters
- data: AccountSchema
Returns Promise<ThirdPartyAccount>

Static loadAll

loadAll(idPrefix?: string): Promise<ThirdPartyAccount[]>

Inherited from AutoSearchAccount.loadAll
- Defined in search/accounts.ts:71
Load all Accountss from the database into the ThirdPartyAccount.accountCache.

Returns an array of the requested accounts. All loaded accounts (including ones not loaded by this request) can be accessed via ThirdPartyAccount.accountCache.

Parameters
- Optional idPrefix: string
Returns Promise<ThirdPartyAccount[]>

Generated using TypeDoc