Skip to content

Commit 074473f

Browse files
Add xml document comments
1 parent f38a939 commit 074473f

File tree

5 files changed

+54
-9
lines changed

5 files changed

+54
-9
lines changed

Src/Notion.Client/Api/Databases/IDatabasesClient.cs

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,36 @@ namespace Notion.Client
44
{
55
public interface IDatabasesClient
66
{
7+
/// <summary>
8+
/// Retrieves a Database object using the ID specified.
9+
/// </summary>
10+
/// <param name="databaseId">Identifier for a Notion database</param>
11+
/// <returns><see cref="Database"/></returns>
712
Task<Database> RetrieveAsync(string databaseId);
13+
14+
/// <summary>
15+
/// Gets a list of Pages contained in the database, filtered and ordered according to the
16+
/// filter conditions and sort criteria provided in the request. The response may contain
17+
/// fewer than <c>page_size</c> of results.
18+
/// </summary>
19+
/// <param name="databaseId"></param>
20+
/// <param name="databasesQueryParameters"></param>
21+
/// <returns><see cref="PaginatedList{T}"/></returns>
822
Task<PaginatedList<Page>> QueryAsync(string databaseId, DatabasesQueryParameters databasesQueryParameters);
923

1024
/// <summary>
1125
/// Creates a database as a subpage in the specified parent page, with the specified properties schema.
1226
/// </summary>
1327
/// <param name="databasesCreateParameters"></param>
14-
/// <returns>Database</returns>
28+
/// <returns><see cref="Database"/></returns>
1529
Task<Database> CreateAsync(DatabasesCreateParameters databasesCreateParameters);
1630

1731
/// <summary>
1832
/// Updates an existing database as specified by the parameters.
1933
/// </summary>
2034
/// <param name="databaseId"></param>
2135
/// <param name="databasesUpdateParameters"></param>
22-
/// <returns>Database</returns>
36+
/// <returns><see cref="Database"/></returns>
2337
Task<Database> UpdateAsync(string databaseId, DatabasesUpdateParameters databasesUpdateParameters);
2438
}
2539
}

Src/Notion.Client/Api/Pages/IPagesClient.cs

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,23 @@ public interface IPagesClient
1313
/// If the parent is a page, the only valid property is <strong>title</strong>.
1414
/// </summary>
1515
/// <param name="pagesCreateParameters">Create page parameters</param>
16-
/// <returns>Created page.</returns>
16+
/// <returns>Created <see cref="Page"/> object.</returns>
1717
Task<Page> CreateAsync(PagesCreateParameters pagesCreateParameters);
1818

19+
/// <summary>
20+
/// Retrieves a Page object using the ID specified.
21+
/// </summary>
22+
/// <param name="pageId">Identifier for a Notion page</param>
23+
/// <returns><see cref="Page"/></returns>
1924
Task<Page> RetrieveAsync(string pageId);
2025

26+
/// <summary>
27+
/// Updates page property values for the specified page.
28+
/// Note: Properties that are not set via the properties parameter will remain unchanged.
29+
/// </summary>
30+
/// <param name="pageId">Identifier for a Notion page</param>
31+
/// <param name="updatedProperties">Property values to update for this page. The keys are the names or IDs of the property and the values are property values.</param>
32+
/// <returns>Updated <see cref="Page"/> object</returns>
2133
Task<Page> UpdatePropertiesAsync(
2234
string pageId,
2335
IDictionary<string, PropertyValue> updatedProperties
@@ -27,15 +39,15 @@ IDictionary<string, PropertyValue> updatedProperties
2739
/// Updates page property values for the specified page.
2840
/// Properties that are not set via the properties parameter will remain unchanged.
2941
/// </summary>
30-
/// <param name="pageId"></param>
31-
/// <param name="pagesUpdateParameters"></param>
32-
/// <returns>Updated page.</returns>
42+
/// <param name="pageId">Identifier for a Notion page</param>
43+
/// <param name="pagesUpdateParameters">Update property parameters</param>
44+
/// <returns>Updated <see cref="Page"/> object</returns>
3345
Task<Page> UpdateAsync(string pageId, PagesUpdateParameters pagesUpdateParameters);
3446

3547
/// <summary>
3648
/// Retrieves a property_item object for a given pageId and propertyId. Depending on the property type, the object returned will either be a value or a paginated list of property item values.
3749
/// </summary>
38-
/// <param name="retrievePropertyItemParameters">sdf sd</param>
50+
/// <param name="retrievePropertyItemParameters">Property body and query parameters</param>
3951
/// <returns><see cref="IPropertyItemObject"/></returns>
4052
Task<IPropertyItemObject> RetrievePagePropertyItem(RetrievePropertyItemParameters retrievePropertyItemParameters);
4153
}

Src/Notion.Client/Api/Search/ISearchClient.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ namespace Notion.Client
44
{
55
public interface ISearchClient
66
{
7+
/// <summary>
8+
/// Searches all original pages, databases, and child pages/databases that are shared with the integration.
9+
///
10+
/// It will not return linked databases, since these duplicate their source databases.
11+
/// </summary>
12+
/// <param name="parameters">Search filters and body parameters</param>
13+
/// <returns><see cref="PaginatedList{IObject}"/></returns>
714
Task<PaginatedList<IObject>> SearchAsync(SearchParameters parameters);
815
}
916
}

Src/Notion.Client/Api/Users/IUsersClient.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,25 @@ namespace Notion.Client
44
{
55
public interface IUsersClient
66
{
7+
/// <summary>
8+
/// Retrieves a User using the ID specified.
9+
/// </summary>
10+
/// <param name="userId">Identifier for a Notion user</param>
11+
/// <returns><see cref="User"/></returns>
712
Task<User> RetrieveAsync(string userId);
13+
14+
/// <summary>
15+
/// Returns a paginated list of Users for the workspace.
16+
///
17+
/// The response may contain fewer than page_size of results.
18+
/// </summary>
19+
/// <returns><see cref="PaginatedList{User}"/></returns>
820
Task<PaginatedList<User>> ListAsync();
921

1022
/// <summary>
1123
/// Retrieves the bot User associated with the API token provided in the authorization header.
1224
/// </summary>
13-
/// <returns>User object of type bot having an owner field with information about the person who authorized the integration.</returns>
25+
/// <returns><see cref="User"/> object of type bot having an owner field with information about the person who authorized the integration.</returns>
1426
Task<User> MeAsync();
1527
}
1628
}

Src/Notion.Client/Notion.Client.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<VersionPrefix>4.0.0-preview</VersionPrefix>
55
<TargetFramework>netstandard2.0</TargetFramework>
6-
<LangVersion>7.3</LangVersion>
6+
<LangVersion>9.0</LangVersion>
77

88
<PackageId>Notion.Net</PackageId>
99
<Authors>Vedant Koditkar</Authors>

0 commit comments

Comments
 (0)