summaryrefslogtreecommitdiff
path: root/FireBase/Query
diff options
context:
space:
mode:
Diffstat (limited to 'FireBase/Query')
-rw-r--r--FireBase/Query/AuthQuery.cs14
-rw-r--r--FireBase/Query/ChildQuery.cs14
-rw-r--r--FireBase/Query/FilterQuery.cs38
-rw-r--r--FireBase/Query/FirebaseQuery.cs162
-rw-r--r--FireBase/Query/IFirebaseQuery.cs28
-rw-r--r--FireBase/Query/OrderQuery.cs12
-rw-r--r--FireBase/Query/ParameterQuery.cs18
-rw-r--r--FireBase/Query/QueryExtensions.cs68
-rw-r--r--FireBase/Query/QueryFactoryExtensions.cs85
-rw-r--r--FireBase/Query/SilentQuery.cs2
10 files changed, 225 insertions, 216 deletions
diff --git a/FireBase/Query/AuthQuery.cs b/FireBase/Query/AuthQuery.cs
index 14beb7e..2cfda3c 100644
--- a/FireBase/Query/AuthQuery.cs
+++ b/FireBase/Query/AuthQuery.cs
@@ -1,18 +1,18 @@
+using System;
+
namespace Firebase.Database.Query
{
- using System;
-
/// <summary>
- /// Represents an auth parameter in firebase query, e.g. "?auth=xyz".
+ /// Represents an auth parameter in firebase query, e.g. "?auth=xyz".
/// </summary>
public class AuthQuery : ParameterQuery
{
private readonly Func<string> tokenFactory;
/// <summary>
- /// Initializes a new instance of the <see cref="AuthQuery"/> class.
+ /// Initializes a new instance of the <see cref="AuthQuery" /> class.
/// </summary>
- /// <param name="parent"> The parent. </param>
+ /// <param name="parent"> The parent. </param>
/// <param name="tokenFactory"> The authentication token factory. </param>
/// <param name="client"> The owner. </param>
public AuthQuery(FirebaseQuery parent, Func<string> tokenFactory, FirebaseClient client) : base(parent,
@@ -22,10 +22,10 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Build the url parameter value of this child.
+ /// Build the url parameter value of this child.
/// </summary>
/// <param name="child"> The child of this child. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected override string BuildUrlParameter(FirebaseQuery child)
{
return tokenFactory();
diff --git a/FireBase/Query/ChildQuery.cs b/FireBase/Query/ChildQuery.cs
index 510ae75..014fe09 100644
--- a/FireBase/Query/ChildQuery.cs
+++ b/FireBase/Query/ChildQuery.cs
@@ -1,16 +1,16 @@
+using System;
+
namespace Firebase.Database.Query
{
- using System;
-
/// <summary>
- /// Firebase query which references the child of current node.
+ /// Firebase query which references the child of current node.
/// </summary>
public class ChildQuery : FirebaseQuery
{
private readonly Func<string> pathFactory;
/// <summary>
- /// Initializes a new instance of the <see cref="ChildQuery"/> class.
+ /// Initializes a new instance of the <see cref="ChildQuery" /> class.
/// </summary>
/// <param name="parent"> The parent. </param>
/// <param name="pathFactory"> The path to the child node. </param>
@@ -22,7 +22,7 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Initializes a new instance of the <see cref="ChildQuery"/> class.
+ /// Initializes a new instance of the <see cref="ChildQuery" /> class.
/// </summary>
/// <param name="client"> The client. </param>
/// <param name="pathFactory"> The path to the child node. </param>
@@ -32,10 +32,10 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Build the url segment of this child.
+ /// Build the url segment of this child.
/// </summary>
/// <param name="child"> The child of this child. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected override string BuildUrlSegment(FirebaseQuery child)
{
var s = pathFactory();
diff --git a/FireBase/Query/FilterQuery.cs b/FireBase/Query/FilterQuery.cs
index be544c8..3434d1d 100644
--- a/FireBase/Query/FilterQuery.cs
+++ b/FireBase/Query/FilterQuery.cs
@@ -1,24 +1,24 @@
+using System;
+using System.Globalization;
+
namespace Firebase.Database.Query
{
- using System;
- using System.Globalization;
-
/// <summary>
- /// Represents a firebase filtering query, e.g. "?LimitToLast=10".
+ /// Represents a firebase filtering query, e.g. "?LimitToLast=10".
/// </summary>
public class FilterQuery : ParameterQuery
{
- private readonly Func<string> valueFactory;
- private readonly Func<double> doubleValueFactory;
private readonly Func<bool> boolValueFactory;
+ private readonly Func<double> doubleValueFactory;
+ private readonly Func<string> valueFactory;
/// <summary>
- /// Initializes a new instance of the <see cref="FilterQuery"/> class.
+ /// Initializes a new instance of the <see cref="FilterQuery" /> class.
/// </summary>
/// <param name="parent"> The parent. </param>
/// <param name="filterFactory"> The filter. </param>
/// <param name="valueFactory"> The value for filter. </param>
- /// <param name="client"> The owning client. </param>
+ /// <param name="client"> The owning client. </param>
public FilterQuery(FirebaseQuery parent, Func<string> filterFactory, Func<string> valueFactory,
FirebaseClient client)
: base(parent, filterFactory, client)
@@ -27,7 +27,7 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Initializes a new instance of the <see cref="FilterQuery"/> class.
+ /// Initializes a new instance of the <see cref="FilterQuery" /> class.
/// </summary>
/// <param name="parent"> The parent. </param>
/// <param name="filterFactory"> The filter. </param>
@@ -41,7 +41,7 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Initializes a new instance of the <see cref="FilterQuery"/> class.
+ /// Initializes a new instance of the <see cref="FilterQuery" /> class.
/// </summary>
/// <param name="parent"> The parent. </param>
/// <param name="filterFactory"> The filter. </param>
@@ -55,25 +55,21 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// The build url parameter.
+ /// The build url parameter.
/// </summary>
- /// <param name="child"> The child. </param>
- /// <returns> Url parameter part of the resulting path. </returns>
+ /// <param name="child"> The child. </param>
+ /// <returns> Url parameter part of the resulting path. </returns>
protected override string BuildUrlParameter(FirebaseQuery child)
{
if (valueFactory != null)
{
- if (valueFactory() == null) return $"null";
+ if (valueFactory() == null) return "null";
return $"\"{valueFactory()}\"";
}
- else if (doubleValueFactory != null)
- {
+
+ if (doubleValueFactory != null)
return doubleValueFactory().ToString(CultureInfo.InvariantCulture);
- }
- else if (boolValueFactory != null)
- {
- return $"{boolValueFactory().ToString().ToLower()}";
- }
+ if (boolValueFactory != null) return $"{boolValueFactory().ToString().ToLower()}";
return string.Empty;
}
diff --git a/FireBase/Query/FirebaseQuery.cs b/FireBase/Query/FirebaseQuery.cs
index 5e09795..60d0289 100644
--- a/FireBase/Query/FirebaseQuery.cs
+++ b/FireBase/Query/FirebaseQuery.cs
@@ -1,29 +1,27 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using System.Net.Http;
+using System.Reactive.Linq;
+using System.Threading.Tasks;
+using Firebase.Database.Http;
+using Firebase.Database.Streaming;
+using Newtonsoft.Json;
+
namespace Firebase.Database.Query
{
- using System;
- using System.Collections.Generic;
- using System.Net.Http;
- using System.Reactive.Linq;
- using System.Threading.Tasks;
- using Http;
- using Offline;
- using Streaming;
- using Newtonsoft.Json;
- using System.Net;
-
/// <summary>
- /// Represents a firebase query.
+ /// Represents a firebase query.
/// </summary>
public abstract class FirebaseQuery : IFirebaseQuery, IDisposable
{
- protected TimeSpan DEFAULT_HTTP_CLIENT_TIMEOUT = new TimeSpan(0, 0, 180);
-
protected readonly FirebaseQuery Parent;
private HttpClient client;
+ protected TimeSpan DEFAULT_HTTP_CLIENT_TIMEOUT = new TimeSpan(0, 0, 180);
- /// <summary>
- /// Initializes a new instance of the <see cref="FirebaseQuery"/> class.
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FirebaseQuery" /> class.
/// </summary>
/// <param name="parent"> The parent of this query. </param>
/// <param name="client"> The owning client. </param>
@@ -34,16 +32,24 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Gets the client.
+ /// Disposes this instance.
+ /// </summary>
+ public void Dispose()
+ {
+ client?.Dispose();
+ }
+
+ /// <summary>
+ /// Gets the client.
/// </summary>
public FirebaseClient Client { get; }
/// <summary>
- /// Queries the firebase server once returning collection of items.
+ /// Queries the firebase server once returning collection of items.
/// </summary>
/// <param name="timeout"> Optional timeout value. </param>
/// <typeparam name="T"> Type of elements. </typeparam>
- /// <returns> Collection of <see cref="FirebaseObject{T}"/> holding the entities returned by server. </returns>
+ /// <returns> Collection of <see cref="FirebaseObject{T}" /> holding the entities returned by server. </returns>
public async Task<IReadOnlyCollection<FirebaseObject<T>>> OnceAsync<T>(TimeSpan? timeout = null)
{
var url = string.Empty;
@@ -62,6 +68,39 @@ namespace Firebase.Database.Query
.ConfigureAwait(false);
}
+ /// <summary>
+ /// Starts observing this query watching for changes real time sent by the server.
+ /// </summary>
+ /// <typeparam name="T"> Type of elements. </typeparam>
+ /// <param name="elementRoot"> Optional custom root element of received json items. </param>
+ /// <returns> Observable stream of <see cref="FirebaseEvent{T}" />. </returns>
+ public IObservable<FirebaseEvent<T>> AsObservable<T>(
+ EventHandler<ExceptionEventArgs<FirebaseException>> exceptionHandler = null, string elementRoot = "")
+ {
+ return Observable.Create<FirebaseEvent<T>>(observer =>
+ {
+ var sub = new FirebaseSubscription<T>(observer, this, elementRoot, new FirebaseCache<T>());
+ sub.ExceptionThrown += exceptionHandler;
+ return sub.Run();
+ });
+ }
+
+ /// <summary>
+ /// Builds the actual URL of this query.
+ /// </summary>
+ /// <returns> The <see cref="string" />. </returns>
+ public async Task<string> BuildUrlAsync()
+ {
+ // if token factory is present on the parent then use it to generate auth token
+ if (Client.Options.AuthTokenAsyncFactory != null)
+ {
+ var token = await Client.Options.AuthTokenAsyncFactory().ConfigureAwait(false);
+ return this.WithAuth(token).BuildUrl(null);
+ }
+
+ return BuildUrl(null);
+ }
+
/*public async Task<IReadOnlyCollection<FirebaseObject<Object>>> OnceAsync(Type dataType, TimeSpan? timeout = null)
{
var url = string.Empty;
@@ -80,11 +119,11 @@ namespace Firebase.Database.Query
}*/
/// <summary>
- /// Assumes given query is pointing to a single object of type <typeparamref name="T"/> and retrieves it.
+ /// Assumes given query is pointing to a single object of type <typeparamref name="T" /> and retrieves it.
/// </summary>
/// <param name="timeout"> Optional timeout value. </param>
/// <typeparam name="T"> Type of elements. </typeparam>
- /// <returns> Single object of type <typeparamref name="T"/>. </returns>
+ /// <returns> Single object of type <typeparamref name="T" />. </returns>
public async Task<T> OnceSingleAsync<T>(TimeSpan? timeout = null)
{
var responseData = string.Empty;
@@ -118,45 +157,12 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Starts observing this query watching for changes real time sent by the server.
- /// </summary>
- /// <typeparam name="T"> Type of elements. </typeparam>
- /// <param name="elementRoot"> Optional custom root element of received json items. </param>
- /// <returns> Observable stream of <see cref="FirebaseEvent{T}"/>. </returns>
- public IObservable<FirebaseEvent<T>> AsObservable<T>(
- EventHandler<ExceptionEventArgs<FirebaseException>> exceptionHandler = null, string elementRoot = "")
- {
- return Observable.Create<FirebaseEvent<T>>(observer =>
- {
- var sub = new FirebaseSubscription<T>(observer, this, elementRoot, new FirebaseCache<T>());
- sub.ExceptionThrown += exceptionHandler;
- return sub.Run();
- });
- }
-
- /// <summary>
- /// Builds the actual URL of this query.
- /// </summary>
- /// <returns> The <see cref="string"/>. </returns>
- public async Task<string> BuildUrlAsync()
- {
- // if token factory is present on the parent then use it to generate auth token
- if (Client.Options.AuthTokenAsyncFactory != null)
- {
- var token = await Client.Options.AuthTokenAsyncFactory().ConfigureAwait(false);
- return this.WithAuth(token).BuildUrl(null);
- }
-
- return BuildUrl(null);
- }
-
- /// <summary>
- /// Posts given object to repository.
+ /// Posts given object to repository.
/// </summary>
/// <param name="obj"> The object. </param>
/// <param name="generateKeyOffline"> Specifies whether the key should be generated offline instead of online. </param>
/// <param name="timeout"> Optional timeout value. </param>
- /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
+ /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam>
/// <returns> Resulting firebase object with populated key. </returns>
public async Task<FirebaseObject<string>> PostAsync(string data, bool generateKeyOffline = true,
TimeSpan? timeout = null)
@@ -169,23 +175,21 @@ namespace Firebase.Database.Query
return new FirebaseObject<string>(key, data);
}
- else
- {
- var c = GetClient(timeout);
- var sendData = await SendAsync(c, data, HttpMethod.Post).ConfigureAwait(false);
- var result = JsonConvert.DeserializeObject<PostResult>(sendData, Client.Options.JsonSerializerSettings);
- return new FirebaseObject<string>(result.Name, data);
- }
+ var c = GetClient(timeout);
+ var sendData = await SendAsync(c, data, HttpMethod.Post).ConfigureAwait(false);
+ var result = JsonConvert.DeserializeObject<PostResult>(sendData, Client.Options.JsonSerializerSettings);
+
+ return new FirebaseObject<string>(result.Name, data);
}
/// <summary>
- /// Patches data at given location instead of overwriting them.
- /// </summary>
+ /// Patches data at given location instead of overwriting them.
+ /// </summary>
/// <param name="obj"> The object. </param>
/// <param name="timeout"> Optional timeout value. </param>
- /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
- /// <returns> The <see cref="Task"/>. </returns>
+ /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam>
+ /// <returns> The <see cref="Task" />. </returns>
public async Task PatchAsync(string data, TimeSpan? timeout = null)
{
var c = GetClient(timeout);
@@ -194,12 +198,12 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Sets or overwrites data at given location.
- /// </summary>
+ /// Sets or overwrites data at given location.
+ /// </summary>
/// <param name="obj"> The object. </param>
/// <param name="timeout"> Optional timeout value. </param>
- /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
- /// <returns> The <see cref="Task"/>. </returns>
+ /// <typeparam name="T"> Type of <see cref="obj" /> </typeparam>
+ /// <returns> The <see cref="Task" />. </returns>
public async Task PutAsync(string data, TimeSpan? timeout = null)
{
var c = GetClient(timeout);
@@ -208,10 +212,10 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Deletes data from given location.
+ /// Deletes data from given location.
/// </summary>
/// <param name="timeout"> Optional timeout value. </param>
- /// <returns> The <see cref="Task"/>. </returns>
+ /// <returns> The <see cref="Task" />. </returns>
public async Task DeleteAsync(TimeSpan? timeout = null)
{
var c = GetClient(timeout);
@@ -243,18 +247,10 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Disposes this instance.
- /// </summary>
- public void Dispose()
- {
- client?.Dispose();
- }
-
- /// <summary>
- /// Build the url segment of this child.
+ /// Build the url segment of this child.
/// </summary>
/// <param name="child"> The child of this query. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected abstract string BuildUrlSegment(FirebaseQuery child);
private string BuildUrl(FirebaseQuery child)
diff --git a/FireBase/Query/IFirebaseQuery.cs b/FireBase/Query/IFirebaseQuery.cs
index 9f6e36c..0da4b15 100644
--- a/FireBase/Query/IFirebaseQuery.cs
+++ b/FireBase/Query/IFirebaseQuery.cs
@@ -1,40 +1,40 @@
-namespace Firebase.Database.Query
-{
- using System;
- using System.Collections.Generic;
- using System.Threading.Tasks;
- using Streaming;
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Firebase.Database.Streaming;
+namespace Firebase.Database.Query
+{
/// <summary>
- /// The FirebaseQuery interface.
+ /// The FirebaseQuery interface.
/// </summary>
public interface IFirebaseQuery
{
/// <summary>
- /// Gets the owning client of this query.
+ /// Gets the owning client of this query.
/// </summary>
FirebaseClient Client { get; }
/// <summary>
- /// Retrieves items which exist on the location specified by this query instance.
+ /// Retrieves items which exist on the location specified by this query instance.
/// </summary>
/// <param name="timeout"> Optional timeout value. </param>
/// <typeparam name="T"> Type of the items. </typeparam>
- /// <returns> Collection of <see cref="FirebaseObject{T}"/>. </returns>
+ /// <returns> Collection of <see cref="FirebaseObject{T}" />. </returns>
Task<IReadOnlyCollection<FirebaseObject<T>>> OnceAsync<T>(TimeSpan? timeout = null);
/// <summary>
- /// Returns current location as an observable which allows to real-time listening to events from the firebase server.
+ /// Returns current location as an observable which allows to real-time listening to events from the firebase server.
/// </summary>
/// <typeparam name="T"> Type of the items. </typeparam>
- /// <returns> Cold observable of <see cref="FirebaseEvent{T}"/>. </returns>
+ /// <returns> Cold observable of <see cref="FirebaseEvent{T}" />. </returns>
IObservable<FirebaseEvent<T>> AsObservable<T>(
EventHandler<ExceptionEventArgs<FirebaseException>> exceptionHandler, string elementRoot = "");
/// <summary>
- /// Builds the actual url of this query.
+ /// Builds the actual url of this query.
/// </summary>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
Task<string> BuildUrlAsync();
}
} \ No newline at end of file
diff --git a/FireBase/Query/OrderQuery.cs b/FireBase/Query/OrderQuery.cs
index 16adba7..302d1a3 100644
--- a/FireBase/Query/OrderQuery.cs
+++ b/FireBase/Query/OrderQuery.cs
@@ -1,16 +1,16 @@
+using System;
+
namespace Firebase.Database.Query
{
- using System;
-
/// <summary>
- /// Represents a firebase ordering query, e.g. "?OrderBy=Foo".
+ /// Represents a firebase ordering query, e.g. "?OrderBy=Foo".
/// </summary>
public class OrderQuery : ParameterQuery
{
private readonly Func<string> propertyNameFactory;
/// <summary>
- /// Initializes a new instance of the <see cref="OrderQuery"/> class.
+ /// Initializes a new instance of the <see cref="OrderQuery" /> class.
/// </summary>
/// <param name="parent"> The query parent. </param>
/// <param name="propertyNameFactory"> The property name. </param>
@@ -22,10 +22,10 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// The build url parameter.
+ /// The build url parameter.
/// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected override string BuildUrlParameter(FirebaseQuery child)
{
return $"\"{propertyNameFactory()}\"";
diff --git a/FireBase/Query/ParameterQuery.cs b/FireBase/Query/ParameterQuery.cs
index fb273a3..572224c 100644
--- a/FireBase/Query/ParameterQuery.cs
+++ b/FireBase/Query/ParameterQuery.cs
@@ -1,9 +1,9 @@
+using System;
+
namespace Firebase.Database.Query
{
- using System;
-
/// <summary>
- /// Represents a parameter in firebase query, e.g. "?data=foo".
+ /// Represents a parameter in firebase query, e.g. "?data=foo".
/// </summary>
public abstract class ParameterQuery : FirebaseQuery
{
@@ -11,7 +11,7 @@ namespace Firebase.Database.Query
private readonly string separator;
/// <summary>
- /// Initializes a new instance of the <see cref="ParameterQuery"/> class.
+ /// Initializes a new instance of the <see cref="ParameterQuery" /> class.
/// </summary>
/// <param name="parent"> The parent of this query. </param>
/// <param name="parameterFactory"> The parameter. </param>
@@ -24,20 +24,20 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Build the url segment represented by this query.
- /// </summary>
+ /// Build the url segment represented by this query.
+ /// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected override string BuildUrlSegment(FirebaseQuery child)
{
return $"{separator}{parameterFactory()}={BuildUrlParameter(child)}";
}
/// <summary>
- /// The build url parameter.
+ /// The build url parameter.
/// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="string"/>. </returns>
+ /// <returns> The <see cref="string" />. </returns>
protected abstract string BuildUrlParameter(FirebaseQuery child);
}
} \ No newline at end of file
diff --git a/FireBase/Query/QueryExtensions.cs b/FireBase/Query/QueryExtensions.cs
index 735fe0a..df2edfc 100644
--- a/FireBase/Query/QueryExtensions.cs
+++ b/FireBase/Query/QueryExtensions.cs
@@ -6,158 +6,163 @@ using Newtonsoft.Json;
namespace Firebase.Database.Query
{
/// <summary>
- /// Query extensions providing linq like syntax for firebase server methods.
+ /// Query extensions providing linq like syntax for firebase server methods.
/// </summary>
public static class QueryExtensions
{
/// <summary>
- /// Adds an auth parameter to the query.
+ /// Adds an auth parameter to the query.
/// </summary>
/// <param name="node"> The child. </param>
/// <param name="token"> The auth token. </param>
- /// <returns> The <see cref="AuthQuery"/>. </returns>
+ /// <returns> The <see cref="AuthQuery" />. </returns>
internal static AuthQuery WithAuth(this FirebaseQuery node, string token)
{
return node.WithAuth(() => token);
}
/// <summary>
- /// Appends print=silent to save bandwidth.
+ /// Appends print=silent to save bandwidth.
/// </summary>
/// <param name="node"> The child. </param>
- /// <returns> The <see cref="SilentQuery"/>. </returns>
+ /// <returns> The <see cref="SilentQuery" />. </returns>
internal static SilentQuery Silent(this FirebaseQuery node)
{
return new SilentQuery(node, node.Client);
}
/// <summary>
- /// References a sub child of the existing node.
+ /// References a sub child of the existing node.
/// </summary>
/// <param name="node"> The child. </param>
/// <param name="path"> The path of sub child. </param>
- /// <returns> The <see cref="ChildQuery"/>. </returns>
+ /// <returns> The <see cref="ChildQuery" />. </returns>
public static ChildQuery Child(this ChildQuery node, string path)
{
return node.Child(() => path);
}
/// <summary>
- /// Order data by given <see cref="propertyName"/>. Note that this is used mainly for following filtering queries and due to firebase implementation
- /// the data may actually not be ordered.
+ /// Order data by given <see cref="propertyName" />. Note that this is used mainly for following filtering queries and
+ /// due to firebase implementation
+ /// the data may actually not be ordered.
/// </summary>
/// <param name="child"> The child. </param>
/// <param name="propertyName"> The property name. </param>
- /// <returns> The <see cref="OrderQuery"/>. </returns>
+ /// <returns> The <see cref="OrderQuery" />. </returns>
public static OrderQuery OrderBy(this ChildQuery child, string propertyName)
{
return child.OrderBy(() => propertyName);
}
/// <summary>
- /// Instructs firebase to send data greater or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data greater or equal to the <see cref="value" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery StartAt(this ParameterQuery child, string value)
{
return child.StartAt(() => value);
}
/// <summary>
- /// Instructs firebase to send data lower or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data lower or equal to the <see cref="value" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EndAt(this ParameterQuery child, string value)
{
return child.EndAt(() => value);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, string value)
{
return child.EqualTo(() => value);
}
/// <summary>
- /// Instructs firebase to send data greater or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data greater or equal to the <see cref="value" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery StartAt(this ParameterQuery child, double value)
{
return child.StartAt(() => value);
}
/// <summary>
- /// Instructs firebase to send data lower or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data lower or equal to the <see cref="value" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EndAt(this ParameterQuery child, double value)
{
return child.EndAt(() => value);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, double value)
{
return child.EqualTo(() => value);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="value" />. This must be preceded by an OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="value"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, bool value)
{
return child.EqualTo(() => value);
}
/// <summary>
- /// Instructs firebase to send data equal to null. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to null. This must be preceded by an OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child)
{
return child.EqualTo(() => null);
}
/// <summary>
- /// Limits the result to first <see cref="count"/> items.
+ /// Limits the result to first <see cref="count" /> items.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="count"> Number of elements. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery LimitToFirst(this ParameterQuery child, int count)
{
return child.LimitToFirst(() => count);
}
/// <summary>
- /// Limits the result to last <see cref="count"/> items.
+ /// Limits the result to last <see cref="count" /> items.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="count"> Number of elements. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery LimitToLast(this ParameterQuery child, int count)
{
return child.LimitToLast(() => count);
@@ -184,7 +189,8 @@ namespace Firebase.Database.Query
}
/// <summary>
- /// Fan out given item to multiple locations at once. See https://firebase.googleblog.com/2015/10/client-side-fan-out-for-data-consistency_73.html for details.
+ /// Fan out given item to multiple locations at once. See
+ /// https://firebase.googleblog.com/2015/10/client-side-fan-out-for-data-consistency_73.html for details.
/// </summary>
/// <typeparam name="T"> Type of object to fan out. </typeparam>
/// <param name="query"> Current node. </param>
diff --git a/FireBase/Query/QueryFactoryExtensions.cs b/FireBase/Query/QueryFactoryExtensions.cs
index b54c315..71dae5c 100644
--- a/FireBase/Query/QueryFactoryExtensions.cs
+++ b/FireBase/Query/QueryFactoryExtensions.cs
@@ -1,173 +1,184 @@
+using System;
+
namespace Firebase.Database.Query
{
- using System;
-
/// <summary>
- /// Query extensions providing linq like syntax for firebase server methods.
+ /// Query extensions providing linq like syntax for firebase server methods.
/// </summary>
public static class QueryFactoryExtensions
{
/// <summary>
- /// Adds an auth parameter to the query.
+ /// Adds an auth parameter to the query.
/// </summary>
/// <param name="node"> The child. </param>
/// <param name="tokenFactory"> The auth token. </param>
- /// <returns> The <see cref="AuthQuery"/>. </returns>
+ /// <returns> The <see cref="AuthQuery" />. </returns>
internal static AuthQuery WithAuth(this FirebaseQuery node, Func<string> tokenFactory)
{
return new AuthQuery(node, tokenFactory, node.Client);
}
/// <summary>
- /// References a sub child of the existing node.
+ /// References a sub child of the existing node.
/// </summary>
/// <param name="node"> The child. </param>
/// <param name="pathFactory"> The path of sub child. </param>
- /// <returns> The <see cref="ChildQuery"/>. </returns>
+ /// <returns> The <see cref="ChildQuery" />. </returns>
public static ChildQuery Child(this ChildQuery node, Func<string> pathFactory)
{
return new ChildQuery(node, pathFactory, node.Client);
}
/// <summary>
- /// Order data by given <see cref="propertyNameFactory"/>. Note that this is used mainly for following filtering queries and due to firebase implementation
- /// the data may actually not be ordered.
+ /// Order data by given <see cref="propertyNameFactory" />. Note that this is used mainly for following filtering
+ /// queries and due to firebase implementation
+ /// the data may actually not be ordered.
/// </summary>
/// <param name="child"> The child. </param>
/// <param name="propertyNameFactory"> The property name. </param>
- /// <returns> The <see cref="OrderQuery"/>. </returns>
+ /// <returns> The <see cref="OrderQuery" />. </returns>
public static OrderQuery OrderBy(this ChildQuery child, Func<string> propertyNameFactory)
{
return new OrderQuery(child, propertyNameFactory, child.Client);
}
/// <summary>
- /// Order data by $key. Note that this is used mainly for following filtering queries and due to firebase implementation
- /// the data may actually not be ordered.
+ /// Order data by $key. Note that this is used mainly for following filtering queries and due to firebase
+ /// implementation
+ /// the data may actually not be ordered.
/// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="OrderQuery"/>. </returns>
+ /// <returns> The <see cref="OrderQuery" />. </returns>
public static OrderQuery OrderByKey(this ChildQuery child)
{
return child.OrderBy("$key");
}
/// <summary>
- /// Order data by $value. Note that this is used mainly for following filtering queries and due to firebase implementation
- /// the data may actually not be ordered.
+ /// Order data by $value. Note that this is used mainly for following filtering queries and due to firebase
+ /// implementation
+ /// the data may actually not be ordered.
/// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="OrderQuery"/>. </returns>
+ /// <returns> The <see cref="OrderQuery" />. </returns>
public static OrderQuery OrderByValue(this ChildQuery child)
{
return child.OrderBy("$value");
}
/// <summary>
- /// Order data by $priority. Note that this is used mainly for following filtering queries and due to firebase implementation
- /// the data may actually not be ordered.
+ /// Order data by $priority. Note that this is used mainly for following filtering queries and due to firebase
+ /// implementation
+ /// the data may actually not be ordered.
/// </summary>
/// <param name="child"> The child. </param>
- /// <returns> The <see cref="OrderQuery"/>. </returns>
+ /// <returns> The <see cref="OrderQuery" />. </returns>
public static OrderQuery OrderByPriority(this ChildQuery child)
{
return child.OrderBy("$priority");
}
/// <summary>
- /// Instructs firebase to send data greater or equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data greater or equal to the <see cref="valueFactory" />. This must be preceded by an
+ /// OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery StartAt(this ParameterQuery child, Func<string> valueFactory)
{
return new FilterQuery(child, () => "startAt", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data lower or equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data lower or equal to the <see cref="valueFactory" />. This must be preceded by an
+ /// OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EndAt(this ParameterQuery child, Func<string> valueFactory)
{
return new FilterQuery(child, () => "endAt", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, Func<string> valueFactory)
{
return new FilterQuery(child, () => "equalTo", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data greater or equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data greater or equal to the <see cref="valueFactory" />. This must be preceded by an
+ /// OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery StartAt(this ParameterQuery child, Func<double> valueFactory)
{
return new FilterQuery(child, () => "startAt", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data lower or equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data lower or equal to the <see cref="valueFactory" />. This must be preceded by an
+ /// OrderBy query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EndAt(this ParameterQuery child, Func<double> valueFactory)
{
return new FilterQuery(child, () => "endAt", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, Func<double> valueFactory)
{
return new FilterQuery(child, () => "equalTo", valueFactory, child.Client);
}
/// <summary>
- /// Instructs firebase to send data equal to the <see cref="valueFactory"/>. This must be preceded by an OrderBy query.
+ /// Instructs firebase to send data equal to the <see cref="valueFactory" />. This must be preceded by an OrderBy
+ /// query.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="valueFactory"> Value to start at. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery EqualTo(this ParameterQuery child, Func<bool> valueFactory)
{
return new FilterQuery(child, () => "equalTo", valueFactory, child.Client);
}
/// <summary>
- /// Limits the result to first <see cref="countFactory"/> items.
+ /// Limits the result to first <see cref="countFactory" /> items.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="countFactory"> Number of elements. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery LimitToFirst(this ParameterQuery child, Func<int> countFactory)
{
return new FilterQuery(child, () => "limitToFirst", () => countFactory(), child.Client);
}
/// <summary>
- /// Limits the result to last <see cref="countFactory"/> items.
+ /// Limits the result to last <see cref="countFactory" /> items.
/// </summary>
/// <param name="child"> Current node. </param>
/// <param name="countFactory"> Number of elements. </param>
- /// <returns> The <see cref="FilterQuery"/>. </returns>
+ /// <returns> The <see cref="FilterQuery" />. </returns>
public static FilterQuery LimitToLast(this ParameterQuery child, Func<int> countFactory)
{
return new FilterQuery(child, () => "limitToLast", () => countFactory(), child.Client);
diff --git a/FireBase/Query/SilentQuery.cs b/FireBase/Query/SilentQuery.cs
index 1960426..d09d38b 100644
--- a/FireBase/Query/SilentQuery.cs
+++ b/FireBase/Query/SilentQuery.cs
@@ -1,7 +1,7 @@
namespace Firebase.Database.Query
{
/// <summary>
- /// Appends print=silent to the url.
+ /// Appends print=silent to the url.
/// </summary>
public class SilentQuery : ParameterQuery
{
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-06-30 21:47:24 +0000