Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Gourmet

Index

Constructors

Properties

_URL: string = ...
_keyManager: KeyManager = KeyManager.instance
_params: GourmetSearchQuery = ...

Methods

  • Sets store address (partial match).

    memberof

    Gourmet

    Parameters

    • address: string

      Store address.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "bands are allowed".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • budget(...budget: string[]): Gourmet
  • Filter by budget codes. Refer to the Budget Master API for search for budget codes. Up to 2 pieces can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...budget: string[]

      Budget codes.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "cards are allowed".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "available for private parties".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "children are allowed".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "has a good selection of cocktail?"

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specifies the number of search results to be output from.

    memberof

    Gourmet

    Parameters

    • count: number

      The number of search results to be output from.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with courses".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • creditCard(...creditCard: string[]): Gourmet
  • Filter by credit card codes. Refer to the Credit Card Master API for credit card codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...creditCard: string[]

      Credit card codes.

    Returns Gourmet

    {this}

  • datum(datum: "world" | "tokyo"): Gourmet
  • Specify the geodetic system of latitude and longitude.

    memberof

    Gourmet

    Parameters

    • datum: "world" | "tokyo"

      World: World Geodetic System (Default), tokyo: Old Japan Geodetic System.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "English menu available".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether to filter by the condition "entertainment facilities available". Note: This filter may not work.

    memberof

    Gourmet

    Parameters

    • equipment: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "all you can drink".

    memberof

    Gourmet

    Parameters

    • freeDrink: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Filter by genre codes. Refer to the Genre Master API for genre codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...genre: string[]

      Genre codes.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with a horigotatsu".

    memberof

    Gourmet

    Parameters

    • horigotatsu: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Specify the key assigned to stores.

    memberof

    Gourmet

    Parameters

    • Rest ...id: string[]

      Id of stores. Up to 20 pieces can be specified.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "karaoke available".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • keyword(...keyword: string[]): Gourmet
  • Specify free words (partial match) such as store name, store name, address, station name, store genre catch, catch. The character code is UTF8. AND search is performed by passing a space-delimited string. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...keyword: string[]

      Free words.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "cell phone available". Note: This filter may not work.

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the criteria "mobile coupons".

    memberof

    Gourmet

    Parameters

    • ktaiCoupon: BooleanNum

      0: false(Default), 1: true, Not specified: no refinement.

    Returns Gourmet

    {this}

  • largeArea(...largeArea: string[]): Gourmet
  • Filter by large area codes. Refer to the Large Area Master API for large area codes. Up to 3 pieces can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...largeArea: string[]

      Large area codes.

    Returns Gourmet

    {this}

  • largeServiceArea(largeServiceArea: string): Gourmet
  • Filter by large service area codes. Refer to the Large Service Area Master API for large service area codes.

    memberof

    Gourmet

    Parameters

    • largeServiceArea: string

      Large service area codes.

    Returns Gourmet

    {this}

  • Specify the latitude of the range search.

    memberof

    Gourmet

    Parameters

    • lat: number

      Latitude.

    Returns Gourmet

    {this}

  • Specify the longitude of the range search.

    memberof

    Gourmet

    Parameters

    • lng: number

      Longitude.

    Returns Gourmet

    {this}

  • middleArea(...middleArea: string[]): Gourmet
  • Filter by middle area codes. Refer to the Middle Area Master API for middle area codes. Up to 5 pieces can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...middleArea: string[]

      Middle area codes.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "open after 11:00 p.m.".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition that "meals are available after 11:00 p.m.".

    memberof

    Gourmet

    Parameters

    • midnightMeal: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Specify names of stores (partial match).

    memberof

    Gourmet

    Parameters

    • Rest ...name: string[]

      Store names.

    Returns Gourmet

    {this}

  • nameAny(...nameAny: string[]): Gourmet
  • Specify names or name-kanas of stores (partial match).

    memberof

    Gourmet

    Parameters

    • Rest ...nameAny: string[]

      Store names or name-kanas.

    Returns Gourmet

    {this}

  • nameKana(...nameKana: string[]): Gourmet
  • Specify name-kanas of stores (partial match).

    memberof

    Gourmet

    Parameters

    • Rest ...nameKana: string[]

      Store name-kanas.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "beautiful night view".

    memberof

    Gourmet

    Parameters

    • nightView: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "non-smoking seats".

    memberof

    Gourmet

    Parameters

    • nonSmoking: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • Specify whether to filter by the condition "open air". Note: This filter may not work.

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • order(order: 1 | 2 | 3 | 4): Gourmet
  • Specify the order of search results. The recommended order will be updated periodically.

    memberof

    Gourmet

    Parameters

    • order: 1 | 2 | 3 | 4

      1:In order of store name, 2:In order of genre code, 3:In order of small area code, 4:In order of recommendation (Default).

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "parking available".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • partyCapacity(partyCapacity: number): Gourmet
  • Specify the minimum banquet capacity.

    memberof

    Gourmet

    Parameters

    • partyCapacity: number

      Minimum banquet capacity.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "pets are allowed".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "private room available".

    memberof

    Gourmet

    Parameters

    • privateRoom: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • range(range: 1 | 2 | 3 | 4 | 5): Gourmet
  • Specify the range of the range search in five levels.

    memberof

    Gourmet

    Parameters

    • range: 1 | 2 | 3 | 4 | 5

      1: 300m, 2: 500m, 3: 1000m (Default), 4: 2000m, 5: 3000m.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "has a good selection of sake (Japanese rice wine)?"

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • serviceArea(...serviceArea: string[]): Gourmet
  • Filter by service area codes. Refer to the Service Area Master API for service area codes. Up to 3 pieces can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...serviceArea: string[]

      Service area codes.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "has a good selection of shochu?"

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "live shows available.

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • smallArea(...smallArea: string[]): Gourmet
  • Filter by small area codes. Refer to the Small Area Master API for small area codes. Up to 5 pieces can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...smallArea: string[]

      Small area codes.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with sommelier". Note: This filter may not work.

    memberof

    Gourmet

    Parameters

    • sommelier: BooleanNum

      0: false(Default), 1: true.

    Returns Gourmet

    {this}

  • special(...special: string[]): Gourmet
  • Filter by special codes. The search condition is AND. Refer to the Special Master API for special codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...special: string[]

      Special codes.

    Returns Gourmet

    {this}

  • specialCategory(...specialCategory: string[]): Gourmet
  • Filter by special category codes. The search condition is AND. Refer to the Special Category Master API for special category codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...specialCategory: string[]

      Special category codes.

    Returns Gourmet

    {this}

  • specialCategoryOr(...specialCategoryOr: string[]): Gourmet
  • Filter by special category codes. The search condition is OR. Refer to the Special Category Master API for special category codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...specialCategoryOr: string[]

      Special category codes.

    Returns Gourmet

    {this}

  • specialOr(...specialOr: string[]): Gourmet
  • Filter by special codes. The search condition is OR. Refer to the Special Master API for special codes. Multiple ones can be specified.

    memberof

    Gourmet

    Parameters

    • Rest ...specialOr: string[]

      Special codes.

    Returns Gourmet

    {this}

  • Specify the number of search results to start outputting.

    memberof

    Gourmet

    Parameters

    • start: number

      The number of search results to start outputting.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with seating".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Sets store phone number (exact match). Single-byte numbers (no hyphen)

    memberof

    Gourmet

    Parameters

    • tel: string

      Store phone number.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with TV / projector".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • type(type: "lite" | "creditCard" | "special" | "special+credit_card"): Gourmet
  • Specifies the type of response item. If lite is specified, only the main items will be output. Refer to the official reference. By specifying credit_card and special, credit cards and specials can be added to the response. Both can be specified by connecting them with +.

    memberof

    Gourmet

    see

    https://webservice.recruit.co.jp/doc/hotpepper/reference.html#a16to

    Parameters

    • type: "lite" | "creditCard" | "special" | "special+credit_card"

      Type of response item.

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition, "Inquiries about weddings, after-parties, etc. are possible".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "with wedding reception".

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

  • Specify whether or not to filter by the condition "has a good selection of wine?"

    memberof

    Gourmet

    Parameters

    Returns Gourmet

    {this}

Generated using TypeDoc