diff options
author | Dennis Kobert <d-kobert@web.de> | 2019-05-19 17:00:02 +0200 |
---|---|---|
committer | Dennis Kobert <d-kobert@web.de> | 2019-05-19 17:00:02 +0200 |
commit | c4d046858e0822b7c2c540ac2368b2c0e88e7a26 (patch) | |
tree | 8ff5cfd8646908784a45762a6148ebc150810160 /FireBase/Query/QueryFactoryExtensions.cs | |
parent | f89f308c525e9deebc6d2cf6416e27dfe1a299dc (diff) |
general refectoring
added 42 as dummy Token
Diffstat (limited to 'FireBase/Query/QueryFactoryExtensions.cs')
-rw-r--r-- | FireBase/Query/QueryFactoryExtensions.cs | 85 |
1 files changed, 48 insertions, 37 deletions
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); |