Packages

c

algolia

AlgoliaClient

class AlgoliaClient extends AnyRef

The AlgoliaClient to query Algolia

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AlgoliaClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AlgoliaClient(applicationId: String, apiKey: String, customHeader: Map[String, String] = Map.empty, configuration: AlgoliaClientConfiguration = AlgoliaClientConfiguration.default, utils: AlgoliaUtils = AlgoliaUtils)

    applicationId

    The APP_ID of your Algolia account

    apiKey

    The API KEY of your Algolia account

    customHeader

    Custom headers to add to every requests

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val analyticsHost: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def close(): Unit
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def execute[QUERY, RESULT](query: QUERY)(implicit executable: Executable[QUERY, RESULT], executor: ExecutionContext): Future[RESULT]
  11. def generateSecuredApiKey(privateApiKey: String, query: Query, userToken: Option[String] = None): String
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def getSecuredApiKeyRemainingValidity(securedApiKey: String): Option[Duration]
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val headers: Map[String, String]
  16. val httpClient: AlgoliaHttpClient
  17. val indexingHosts: Seq[String]
  18. val insightsHost: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val logger: Logger
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. var personalizationHost: String
  25. val queryHosts: Seq[String]
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. val userAgent: String
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. var recommendationHost: String
    Annotations
    @deprecated
    Deprecated

    (Since version 1.40.0) use personalization instead

Inherited from AnyRef

Inherited from Any

Ungrouped