Interface HostProfilesService

interface HostProfilesService {
    getMetadata(
        hostId: string,
    ): Promise<undefined | PageResponse<HostProfileMetadata>>;
    getPublicProfile(hostId: string): Promise<HostProfileResponse>;
    publishMetadata(
        metadata: HostProfileMetadata,
    ): Promise<PageResponse<HostProfileMetadata>>;
    setPublishToCollectionName(schemaCollectionName?: string): Promise<void>;
    unpublishMetadata(hostId: string): Promise<void>;
    updatePublicProfile(
        hostId: string,
        profile: HostProfileRequest,
    ): Promise<HostProfileResponse>;
}

Methods

getMetadata getPublicProfile publishMetadata setPublishToCollectionName unpublishMetadata updatePublicProfile

Methods

getMetadata

getPublicProfile

publishMetadata

setPublishToCollectionName

  • setPublishToCollectionName(schemaCollectionName?: string): Promise<void>

  • Set the collection name to publish to only needs to be called once

    Parameters

    • OptionalschemaCollectionName: string

      Optional collection name to publish to (host_profile_pages by default)

    Returns Promise<void>

unpublishMetadata

updatePublicProfile

Settings

Member Visibility

On This Page

Methods