Class RedirectorService

Represents the redirector service.

Constructors

constructor

new RedirectorService(
redirectorRepository: RedirectorRepository,
): RedirectorService
Creates a new service instance.
Parameters
- redirectorRepository: RedirectorRepository
  The redirector repository instance.
Returns RedirectorService
- Defined in modules/redirector/redirector.service.ts:42

Methods

appendField

appendField(
    data: {
        campaignId: string;
        field: string;
        lockSecret: string;
        redirectorId: string;
    },
): Promise<void>
Appends a required field to the redirector.
Parameters
- data: { campaignId: string; field: string; lockSecret: string; redirectorId: string }
  The data object.
Returns Promise<void>
- Defined in modules/redirector/redirector.service.ts:145

create

create(
    data: {
        campaignId: string;
        lockSecret: string;
        page: string;
        redirectorId: string;
    },
): Promise<FullRedirectorModel>
Creates a new redirector.
Parameters
- data: { campaignId: string; lockSecret: string; page: string; redirectorId: string }
  The data object.
Returns Promise<FullRedirectorModel>
The created redirector model.
- Defined in modules/redirector/redirector.service.ts:50

delete

delete(
data: { campaignId: string; lockSecret: string; redirectorId: string },
): Promise<void>
Deletes the redirector by its ID.
Parameters
- data: { campaignId: string; lockSecret: string; redirectorId: string }
  The data object.
Returns Promise<void>
- Defined in modules/redirector/redirector.service.ts:211

list

list(data: { campaignId: string }): Promise<RedirectorModel[]>
Lists all redirectors for the campaign.
Parameters
- data: { campaignId: string }
  The data object.
Returns Promise<RedirectorModel[]>
The array of redirector models.
- Defined in modules/redirector/redirector.service.ts:239

read

read(
data: { campaignId: string; redirectorId: string },
): Promise<FullRedirectorModel>
Reads the redirector by its ID.
Parameters
- data: { campaignId: string; redirectorId: string }
  The data object.
Returns Promise<FullRedirectorModel>
The redirector model.

Throws
ReplServerError If the redirector is not found.
- Defined in modules/redirector/redirector.service.ts:95

removeField

removeField(
    data: {
        campaignId: string;
        field: string;
        lockSecret: string;
        redirectorId: string;
    },
): Promise<void>
Removes a required field from the redirector.
Parameters
- data: { campaignId: string; field: string; lockSecret: string; redirectorId: string }
  The data object.
Returns Promise<void>
- Defined in modules/redirector/redirector.service.ts:178

update

update(
    data: {
        campaignId: string;
        lockSecret: string;
        page: string | null | undefined;
        redirectorId: string;
    },
): Promise<void>
Updates the redirector specific fields.
Parameters
- data: {
      campaignId: string;
      lockSecret: string;
      page: string | null | undefined;
      redirectorId: string;
  }
  The data object.
Returns Promise<void>
- Defined in modules/redirector/redirector.service.ts:112

`Static`register

register(container: DIContainer): void
Registers the service as a singleton in the DI container.
Parameters
- container: DIContainer
  The DI container to register in.
Returns void
- Defined in modules/redirector/redirector.service.ts:30

Class RedirectorService

Constructors

constructor

Parameters

Returns RedirectorService

Methods

appendField

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<FullRedirectorModel>

delete

Parameters

Returns Promise<void>

list

Parameters

Returns Promise<RedirectorModel[]>

read

Parameters

Returns Promise<FullRedirectorModel>

Throws

removeField

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<void>

Staticregister

Parameters

Returns void

`Static`register