@haxall/haxall
    Preparing search index...

    Class OAuthClient

    OAuthClient

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Do an HTTP request with the given method (GET, PUT, etc.) to the given URI. You can also pass additional headers to include with the request. This method will handle OAuth token refresh.

      If the req parameter is non-null, it will be first be converted to a File as described below and then written as the request body (see WebClient.writeFile).

      • File: no conversion done, file is written as-is
      • Buf: converted to a File using Buf.toFile. The Content-Type will be application/octet-stream.
      • Map: encoded to JSON and written as a File with .json ext.

      Returns a WebClient in a state where web::WebClient.readRes has been called and the web::WebClient.resIn is available for reading.

      Parameters

      • method: string
      • uri: Uri
      • Optionalreq: JsObj
      • Optionalheaders: Map<string, string>

      Returns WebClient

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Utility to obtain a raw WebClient with uri, method, and headers set (including Bearer token)

      Parameters

      • method: string
      • uri: Uri
      • Optionalheaders: Map<string, string>

      Returns WebClient

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Create a basic OAuthClient with the given access token. Token refresh is not supported.

      Parameters

      Returns OAuthClient

    • Create an OAuthClient that supports token refresh. The tokenUri is the endpoint to use to refresh the token. The params must at least include the client_id parameter.

      Parameters

      Returns OAuthClient