Class CampaignService

Represents the campaign service.

Constructors

constructor

new CampaignService(campaignRepository: CampaignRepository): CampaignService
Creates a new service instance.
Parameters
- campaignRepository: CampaignRepository
  The campaign repository instance.
Returns CampaignService
- Defined in modules/campaign/campaign.service.ts:42

Methods

create

create(
    data: {
        campaignId: string;
        cryptSecret: string | null | undefined;
        description: string;
        messageExpire: number;
        mirrorDomain: string;
        newSessionExpire: number;
        sessionCookieName: string | null | undefined;
        sessionExpire: number;
        upgradeSessionPath: string;
    },
): Promise<FullCampaignModel>
Creates a new campaign.
Parameters
- data: {
      campaignId: string;
      cryptSecret: string | null | undefined;
      description: string;
      messageExpire: number;
      mirrorDomain: string;
      newSessionExpire: number;
      sessionCookieName: string | null | undefined;
      sessionExpire: number;
      upgradeSessionPath: string;
  }
  The data object.
Returns Promise<FullCampaignModel>
The created campaign model.
- Defined in modules/campaign/campaign.service.ts:50

delete

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

list

list(): Promise<CampaignModel[]>
Lists all campaigns.

Returns Promise<CampaignModel[]>
The array of campaign models.
- Defined in modules/campaign/campaign.service.ts:229

lock

lock(data: { campaignId: string }): Promise<string>
Acquires a distributed lock for the campaign.
Parameters
- data: { campaignId: string }
  The data object.
Returns Promise<string>
The campaign lock secret.
- Defined in modules/campaign/campaign.service.ts:123

read

read(data: { campaignId: string }): Promise<FullCampaignModel>
Reads the campaign by its ID.
Parameters
- data: { campaignId: string }
  The data object.
Returns Promise<FullCampaignModel>
The campaign model.

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

unlock

unlock(data: { campaignId: string; lockSecret: string }): Promise<void>
Releases a previously acquired lock on the campaign.
Parameters
- data: { campaignId: string; lockSecret: string }
  The data object.
Returns Promise<void>
- Defined in modules/campaign/campaign.service.ts:146

update

update(
    data: {
        campaignId: string;
        description: string | null | undefined;
        lockSecret: string;
        messageExpire: number | null | undefined;
        newSessionExpire: number | null | undefined;
        sessionExpire: number | null | undefined;
    },
): Promise<void>
Updates the campaign specific fields.
Parameters
- data: {
      campaignId: string;
      description: string | null | undefined;
      lockSecret: string;
      messageExpire: number | null | undefined;
      newSessionExpire: number | null | undefined;
      sessionExpire: number | null | undefined;
  }
  The data object.
Returns Promise<void>
- Defined in modules/campaign/campaign.service.ts:169

`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/campaign/campaign.service.ts:30

Class CampaignService

Constructors

constructor

Parameters

Returns CampaignService

Methods

create

Parameters

Returns Promise<FullCampaignModel>

delete

Parameters

Returns Promise<void>

list

Returns Promise<CampaignModel[]>

lock

Parameters

Returns Promise<string>

read

Parameters

Returns Promise<FullCampaignModel>

Throws

unlock

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<void>

Staticregister

Parameters

Returns void

`Static`register