Home

Plugin : Firebase

Author:Rex.Rainbow

Download

Properties

Domain

  • The root location of the Firebase data.

Connection detection

  • Enable connection detection.
    • Options : ["No","Yes"]

Server time offset detection

  • Enable server time offset detection.
    • Options : ["No","Yes"]

Actions

Domain

Action:Set domain

  • Set domain ref.
    • Domain ( string ) : The Firebase data ref URL

On disconnect

Action:Remove

  • Remove all values at data ref when disconnected. Uses under "condition: On received".
    • DataRef ( string ) : The Firebase data ref URL

Action:Set value

  • Sets value at data ref when disconnected. Uses under "condition: On received".
    • DataRef ( string ) : The Firebase data ref URL
    • Value ( number or string ) : The value to set

Action:Update JSON

  • Updates JSON values at the data ref when disconnected. Uses under "condition: On received".
    • DataRef ( string ) : The Firebase data ref URL
    • JSON value ( string ) : JSON value to set

Action:Cancel

  • Cancel disconnected writing.
    • DataRef ( string ) : The Firebase data ref URL

Online

Action:Go offline

  • Manually disconnect the Firebase client from the server and disable automatic reconnection. .

Action:Go online

  • Manually reestablish a connection to the Firebase server and enable automatic reconnection. . .

Query

Action:Add callback

  • Add received callback.
    • Query ( object ) : Query object.
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]
    • Callback function ( string ) : Callback function.

Action:Add callback once

  • Add received callback once.
    • Query ( object ) : Query object.
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]
    • Callback function ( string ) : Callback function.

Receive - Add

Action:Add callback

  • Add received callback.
    • DataRef ( string ) : The Firebase data ref URL
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]
    • Callback function ( string ) : Callback function.

Receive - Add once

Action:Add once

  • Add received callback once.
    • DataRef ( string ) : The Firebase data ref URL
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]
    • Callback function ( string ) : Callback function.

Receive - Remove

Action:Remove callback

  • Remove received callback.
    • DataRef ( string ) : The Firebase data ref URL
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]
    • Callback function ( string ) : Callback function.

Action:Remove callback by type

  • Remove all received callbacks by type.
    • DataRef ( string ) : The Firebase data ref URL
    • Type ( Combo ) : Event type
      • Options : ["Value changed","Child added","Child changed","Child removed","Child moved"]

Action:Remove all callbacks at ref

  • Remove all received callbacks at ref.
    • DataRef ( string ) : The Firebase data ref URL

Action:Remove all callbacks

  • Remove all registered received callbacks.

Send - Push

Action:Push value

  • Push value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • Value ( number or string ) : The value to set
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Push JSON

  • Push JSON value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • JSON value ( string ) : JSON value to set
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Push boolean value

  • Push boolean value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • Boolean ( Combo ) : Boolean value.
      • Options : ["False","True"]
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Push server timestamp

  • Push server timestamp at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Send - Remove

Action:Remove

  • Remove all values at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Send - Set

Action:Set value

  • Sets value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • Value ( number or string ) : The value to set
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Set JSON

  • Sets JSON value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • JSON value ( string ) : JSON value to set
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Set boolean value

  • Sets boolean value at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • Boolean ( Combo ) : Boolean value.
      • Options : ["False","True"]
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Set server timestamp

  • Sets server timestamp at data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Send - Transaction

Action:Transaction

  • Transaction value with callback.
    • DataRef ( string ) : The Firebase data ref URL
    • On transaction ( string ) : On transaction function.
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Action:Set value

  • Returns transaction value.
    • Value ( number or string ) : The value to set

Action:Set JSON

  • Returns transaction JSON.
    • JSON value ( string ) : JSON value to set

Send - Update JSON

Action:Update JSON

  • Updates JSON values at the data ref.
    • DataRef ( string ) : The Firebase data ref URL
    • JSON value ( string ) : JSON value to set
    • On complete ( string ) : On complete callback, ignored if enter an empty string "".

Expressions

Domain

Expression:Domain

  • Get root location reference.

Error

Expression:LastErrorCode

  • Error code.

Expression:LastErrorMessage

  • Error message (error.serverResponse) .

ItemID

Expression:GenerateKey

  • Generate new key from push action.

Expression:LastGeneratedKey

  • Get last generate a key from push action.

Push

Expression:LastPushRef

  • Data reference at last push.

Receive

Expression:LastData

  • Received data, using under "condition:On received". JSON will be stringified. Add default value at 1st parameter if read data is null.

Expression:LastKey

  • Key of received data, using under "condition:On received"

Expression:PrevChildName

  • Previous child name, using under "condition:On received" with one of "Child added", "Child changed", "Child moved" type. Add default value at 1st parameter if read data is null.

Send - Transaction

Expression:TransactionIn

  • Transaction input parameter, using under "condition:On transaction", JSON will be stringified. Add default value at 1st parameter if read data is null.

Expression:TransactionResult

  • Transaction wrote result, using under "condition:On completed", JSON will be stringified. Add default value at 1st parameter if read data is null.

Server time offset

Expression:ServerTimeOffset

  • Get current server time offset.

Expression:EstimatedTime

  • Get estimated time from curent time + current server time offset.

Conditions

Connection

Condition:On connected

  • Triggered while connecting start.

Condition:On disconnected

  • Triggered while disconnected.

Condition:Is connected

  • Return true if connected to firebase server.

Receive

Condition:On received

  • Triggered when registered received event received.
    • Callback function ( string ) : Callback function.

Condition:LastData is null

  • Return true if LastData is null.

Send

Condition:On complete

  • Triggered after any sending action success.
    • Callback function ( string ) : Callback function.

Condition:On error

  • Triggered after any sending action error.
    • Callback function ( string ) : Callback function.

Transaction

Condition:On transaction

  • Triggered by calling "action: Transaction", to get return value.
    • Callback function ( string ) : Callback function.

Condition:TransactionIn is null

  • Return true if TransactionIn is null.

Transaction - completed

Condition:On complete

  • Triggered when transaction success.
    • Callback function ( string ) : Callback function.

Condition:On error

  • Triggered when transaction error.
    • Callback function ( string ) : Callback function.

Condition:On aborted

  • Triggered when transaction aborted.
    • Callback function ( string ) : Callback function.