org.restonfire

Interface FirebaseSecurityRulesReference

public interface FirebaseSecurityRulesReference

FirebaseSecurityRulesReference allows for updating of Firebase's security rules. It can be used to get or set the security rules using the REST API.

Note: The security rules requires the access token to be a Firebase secret!

Method Summary

Methods

Modifier and Type	Method and Description
org.jdeferred.Promise<FirebaseSecurityRules,FirebaseRuntimeException,java.lang.Void>	get() Retrieves the rules currently configured for the FirebaseRestDatabase.
org.jdeferred.Promise<FirebaseSecurityRules,FirebaseRuntimeException,java.lang.Void>	set(FirebaseSecurityRules newRules) Replaces the existing security rules with the ones provided when invoking this method.

Method Detail

get

org.jdeferred.Promise<FirebaseSecurityRules,FirebaseRuntimeException,java.lang.Void> get()

Retrieves the rules currently configured for the FirebaseRestDatabase.

Returns:

The FirebaseSecurityRules

set

org.jdeferred.Promise<FirebaseSecurityRules,FirebaseRuntimeException,java.lang.Void> set(FirebaseSecurityRules newRules)

Replaces the existing security rules with the ones provided when invoking this method. All previous rules will be replaced in this method.

Parameters:

newRules - The new set of rules that should be applied from now on.

Returns:

A promise which will resolve with the FirebaseSecurityRules object passed in as the value if the request was successful.