record TgoBsonJavaScriptWithScope

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TgoBsonJavaScriptWithScope = record

Description

A piece of JavaScript code with a scope (a set of variables with values, as defined in another document).

Overview

Methods

class function Create(const ACode: String; const AScope: TgoBsonDocument): TgoBsonJavaScriptWithScope; static;
class operator Implicit(const A: TgoBsonJavaScriptWithScope): TgoBsonValue; static;
class operator Equal(const A, B: TgoBsonJavaScriptWithScope): Boolean; static;
class operator NotEqual(const A, B: TgoBsonJavaScriptWithScope): Boolean; static;
function IsNil: Boolean; inline;
procedure SetNil; inline;
function Clone: TgoBsonJavaScriptWithScope; inline;
function DeepClone: TgoBsonJavaScriptWithScope; inline;
function ToBson: TBytes; inline;
function ToJson: String; overload; inline;
function ToJson(const ASettings: TgoJsonWriterSettings): String; overload; inline;

Properties

property Code: String read GetCode;
property Scope: TgoBsonDocument read GetScope;

Description

Methods

class function Create(const ACode: String; const AScope: TgoBsonDocument): TgoBsonJavaScriptWithScope; static;

Creates a BSON JavaScript w/scope.

Parameters
ACode
the JavaScript code.
AScope
the scope document containing the variables with values.
Returns

The BSON JavaScript w/scope

Exceptions raised
EArgumentNilException
if AScope has not been assigned (IsNil returns True)
class operator Implicit(const A: TgoBsonJavaScriptWithScope): TgoBsonValue; static;

Implicitly casts a BSON JavaScript w/scope to a BSON value.

class operator Equal(const A, B: TgoBsonJavaScriptWithScope): Boolean; static;

See TgoBsonValue.Equal

class operator NotEqual(const A, B: TgoBsonJavaScriptWithScope): Boolean; static;

See TgoBsonValue.NotEqual

function IsNil: Boolean; inline;

See TgoBsonValue.IsNil

procedure SetNil; inline;

See TgoBsonValue.SetNil

function Clone: TgoBsonJavaScriptWithScope; inline;

See TgoBsonValue.Clone

function DeepClone: TgoBsonJavaScriptWithScope; inline;

See TgoBsonValue.DeepClone

function ToBson: TBytes; inline;

See TgoBsonValue.ToBson

function ToJson: String; overload; inline;

See TgoBsonValue.ToJson

function ToJson(const ASettings: TgoJsonWriterSettings): String; overload; inline;

See TgoBsonValue.ToJson

Properties

property Code: String read GetCode;

The JavaScript code

property Scope: TgoBsonDocument read GetScope;

The scope document containing the variables with values.


Generated by P2PasDoc 0.13.0 on 2017-04-25 12:54:26