Websites v4 docs v5.2.5
    Preparing search index...

    Class Branch

    Hierarchy

    Index

    Properties

    pagination recentPropertiesSearchParams serializer

    Accessors

    accessibilityUrl agencyId agencyName branchManager branchOpeningTimes commissionFeesAndCharges contactTelephone county departments depositFees description displayAddress distance email facebookUri franchiseeName generalFees hasFeatureProperties hasSocialLinks heroImage id initialFees instagramUri isLettingsEnabled isSalesEnabled isVirtualOffice lat lettingsEmail lettingsTelephone linkedinUri lng mainPhoto name news openingTimes openingTimesJoined photos position postcode renewalFees salesEmail salesTelephone services sharedLettingsBranch sharedSalesBranch shortDescription slug staffProfiles streetAddress tenantFees town twitterUri uniqueSellingPoints urlLabel wantedAds

    Methods

    get getAgency getArticles getCalendarEventProperties getCalendarEvents getExtendedData getFeatureProperties getHometrackPropertyMarketStatistics getRecentLetProperties getRecentLettingsProperties getRecentSalesProperties getRecentSoldProperties getTestimonials toJSON findAll findById findOne search

    Properties

    pagination: Pagination | null
    recentPropertiesSearchParams: { sort: string[]; status: string } = ...
    serializer: (model: any) => any

    serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

    Accessors

    Methods

    • Retrieves a value from raw API data. Prioritises DBAPI data if available

      Parameters

      • key: string

      Returns any

    • Returns the agency for this branch. Uses the current agency where possible to avoid an additional API request — only fetches by ID for donor agency branches.

      Returns Promise<Agency | null>

    • Fetches dbapi data to make available for additional getters without harming performance of themes that only require hestia data.

      Returns Promise<void>

    • Returns an array of objects containing the feature_property metadata, attached to the branch hestia response, as well as a Property model instance.

      The id for each feature_property is used to asynchronously fetch a Property instance for each entry.

      Returns Promise<{ metadata: HestiaFeatureProperty; property: Property }[] | null>

    • Parameters

      • pageSize: number = 5

      Returns Promise<{ pagination: Pagination; properties: Property[] | null } | null>

    • Parameters

      • pageSize: number = 5

      Returns Promise<{ pagination: Pagination; properties: Property[] | null } | null>

    • Parameters

      • pageSize: number = 5

      Returns Promise<{ pagination: Pagination; properties: Property[] | null } | null>

    • Parameters

      • pageSize: number = 5

      Returns Promise<{ pagination: Pagination; properties: Property[] | null } | null>

    • Special method to define behaviour of JSON.stringify() on model instance

      Returns any

    • Parameters

      Returns Promise<
          {
              errors: ModelError[]
              | null;
              pagination: Pagination | null;
              results: Branch[];
          },
      >

    • Parameters

      • __namedParameters: {
            coord?: { lat: number; lng: number };
            county?: string;
            distance?: number;
            fields?: BranchHestiaFields;
            location?: string;
            page?: number;
            pageSize?: number;
            placeId?: string;
            postcode?: string;
            search?: BranchHestiaSearchParams;
            sort?: string;
        }

      Returns Promise<
          {
              errors: ModelError[]
              | null;
              pagination: Pagination | null;
              results: Branch[];
          },
      >

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods