FacetService
FacetService
Contains methods relating to Facet entities.
Signature
class FacetService {
constructor(connection: TransactionalConnection, facetValueService: FacetValueService, translatableSaver: TranslatableSaver, listQueryBuilder: ListQueryBuilder, configService: ConfigService, channelService: ChannelService, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService, roleService: RoleService)
findAll(ctx: RequestContext, options?: ListQueryOptions<Facet>, relations?: RelationPaths<Facet>) => Promise<PaginatedList<Translated<Facet>>>;
findOne(ctx: RequestContext, facetId: ID, relations?: RelationPaths<Facet>) => Promise<Translated<Facet> | undefined>;
findByCode(facetCode: string, lang: LanguageCode) => Promise<Translated<Facet> | undefined>;
findByCode(ctx: RequestContext, facetCode: string, lang: LanguageCode) => Promise<Translated<Facet> | undefined>;
findByCode(ctxOrFacetCode: RequestContext | string, facetCodeOrLang: string | LanguageCode, lang?: LanguageCode) => Promise<Translated<Facet> | undefined>;
async findByFacetValueId(ctx: RequestContext, id: ID) => Promise<Translated<Facet> | undefined>;
async create(ctx: RequestContext, input: CreateFacetInput) => Promise<Translated<Facet>>;
async update(ctx: RequestContext, input: UpdateFacetInput) => Promise<Translated<Facet>>;
async delete(ctx: RequestContext, id: ID, force: boolean = false) => Promise<DeletionResponse>;
async assignFacetsToChannel(ctx: RequestContext, input: AssignFacetsToChannelInput) => Promise<Array<Translated<Facet>>>;
async removeFacetsFromChannel(ctx: RequestContext, input: RemoveFacetsFromChannelInput) => Promise<Array<ErrorResultUnion<RemoveFacetFromChannelResult, Facet>>>;
}
Members
constructor
method
type:
(connection: TransactionalConnection, facetValueService: FacetValueService, translatableSaver: TranslatableSaver, listQueryBuilder: ListQueryBuilder, configService: ConfigService, channelService: ChannelService, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService, roleService: RoleService) => FacetService
findAll
method
type:
(ctx: RequestContext, options?: ListQueryOptions<Facet>, relations?: RelationPaths<Facet>) => Promise<PaginatedList<Translated<Facet>>>
findOne
method
type:
(ctx: RequestContext, facetId: ID, relations?: RelationPaths<Facet>) => Promise<Translated<Facet> | undefined>
findByCode
method
type:
(facetCode: string, lang: LanguageCode) => Promise<Translated<Facet> | undefined>
findByCode
method
type:
(ctx: RequestContext, facetCode: string, lang: LanguageCode) => Promise<Translated<Facet> | undefined>
findByCode
method
type:
(ctxOrFacetCode: RequestContext | string, facetCodeOrLang: string | LanguageCode, lang?: LanguageCode) => Promise<Translated<Facet> | undefined>
findByFacetValueId
method
type:
(ctx: RequestContext, id: ID) => Promise<Translated<Facet> | undefined>
Returns the Facet which contains the given FacetValue id.
create
method
type:
(ctx: RequestContext, input: CreateFacetInput) => Promise<Translated<Facet>>
update
method
type:
(ctx: RequestContext, input: UpdateFacetInput) => Promise<Translated<Facet>>
delete
method
type:
(ctx: RequestContext, id: ID, force: boolean = false) => Promise<DeletionResponse>
assignFacetsToChannel
method
type:
(ctx: RequestContext, input: AssignFacetsToChannelInput) => Promise<Array<Translated<Facet>>>
Assigns Facets to the specified Channel
removeFacetsFromChannel
method
type:
(ctx: RequestContext, input: RemoveFacetsFromChannelInput) => Promise<Array<ErrorResultUnion<RemoveFacetFromChannelResult, Facet>>>
Remove Facets from the specified Channel