@acceleratxr/core_sdk / ContactService

Class: ContactService

Hierarchy

• ServiceBase

  ↳ ContactService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• create

• delete

• findAll

• findById

• truncate

• update

Constructors

constructor

+ new ContactService(apiClient: ApiClient, config: Configuration): ContactService

Overrides ServiceBase.constructor

Defined in src/services/ContactService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: ContactService

Properties

apiClient

• Protected apiClient: ApiClient

Inherited from ServiceBase.apiClient

Defined in src/ServiceBase.ts:14

The API Client used when making requests to the API backend server.

---

config

• Protected config: Configuration

Inherited from ServiceBase.config

Defined in src/ServiceBase.ts:19

The SDK configuration to use.

---

uuid

▪ Static uuid: string = “d193a7d7-b98c-43fe-9bd9-54858152f522”

Defined in src/services/ContactService.ts:16

Methods

count

▸ count(query?: any): Promise<number>

Defined in src/services/ContactService.ts:57

Returns the count of contacts

Parameters:

Name	Type
query?	any

Returns: Promise<number>

---

create

▸ create(obj: Contact): Promise<Contact | undefined>

Defined in src/services/ContactService.ts:33

Create a new contact

Parameters:

Name	Type
obj	Contact

Returns: Promise<Contact | undefined>

---

delete

▸ delete(id: string): Promise<void>

Defined in src/services/ContactService.ts:102

Deletes the contact

Parameters:

Name	Type
id	string

Returns: Promise<void>

---

findAll

▸ findAll(query?: any): Promise<Contact[] | undefined>

Defined in src/services/ContactService.ts:21

Returns all contacts from the system that the user has access to

Parameters:

Name	Type
query?	any

Returns: Promise<Contact[] | undefined>

---

findById

▸ findById(id: string): Promise<Contact | undefined>

Defined in src/services/ContactService.ts:76

Returns a single contact from the system that the user has access to

Parameters:

Name	Type
id	string

Returns: Promise<Contact | undefined>

---

truncate

▸ truncate(query?: any): Promise<void>

Defined in src/services/ContactService.ts:45

Deletes all contacts from the service.

Parameters:

Name	Type
query?	any

Returns: Promise<void>

---

update

▸ update(id: string, obj: Contact): Promise<Contact | undefined>

Defined in src/services/ContactService.ts:89

Updates a single contact

Parameters:

Name	Type
id	string
obj	Contact

Returns: Promise<Contact | undefined>