Skip to content

Commit

Permalink
53 add missing comments about paginated results
Browse files Browse the repository at this point in the history
  • Loading branch information
Sevitas committed Jan 13, 2022
1 parent f2d7108 commit 35de053
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions Kentico.Kontent.Management/IManagementClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,9 @@ public interface IManagementClient

/// <summary>
/// Returns strongly typed listing of assets.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>,
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>,
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{AssetModel}"/> instance that represents the listing of assets.</returns>
Task<IListingResponseModel<AssetModel>> ListAssetsAsync();
Expand All @@ -253,33 +253,45 @@ public interface IManagementClient

/// <summary>
/// Returns strongly typed listing of content items.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>,
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>,
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{ContentItemModel}"/> instance that represents the listing of content items.</returns>
Task<IListingResponseModel<ContentItemModel>> ListContentItemsAsync();

/// <summary>
/// Returns listing of content types.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{ContentTypeModel}"/> instance that represents the listing of content types.</returns>
Task<IListingResponseModel<ContentTypeModel>> ListContentTypesAsync();

/// <summary>
/// Returns listing of content type snippets.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{ContentTypeSnippetModel}"/> instance that represents the listing of content type snippets.</returns>
Task<IListingResponseModel<ContentTypeSnippetModel>> ListContentTypeSnippetsAsync();

/// <summary>
/// Returns listing of languages.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{LanguageModel}"/> instance that represents the listing of languages.</returns>
Task<IListingResponseModel<LanguageModel>> ListLanguagesAsync();

/// <summary>
/// Returns strongly typed listing of language variants for specified collection.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <param name="identifier">The identifier of the collection.</param>
/// <returns>The <see cref="IEnumerable{LanguageVariantModel}"/> instance that represents the listing of language variants.</returns>
Expand All @@ -302,20 +314,29 @@ public interface IManagementClient

/// <summary>
/// Returns strongly typed listing of language variants for the specified content type.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <param name="identifier">The identifier of the content type.</param>
/// <returns>The <see cref="IEnumerable{LanguageVariantModel}"/> instance that represents the listing of language variants.</returns>
Task<IListingResponseModel<LanguageVariantModel>> ListLanguageVariantsByTypeAsync(Reference identifier);

/// <summary>
/// Returns strongly typed listing of language variants containing components by type.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <param name="identifier">The identifier of the content type.</param>
/// <returns>The <see cref="IEnumerable{LanguageVariantModel}"/> instance that represents the listing of language variants.</returns>
Task<IListingResponseModel<LanguageVariantModel>> ListLanguageVariantsOfContentTypeWithComponentsAsync(Reference identifier);

/// <summary>
/// Returns listing of taxonomy groups.
/// The Content management API returns a dynamically paginated listing response limited to up to 100 objects.
/// To check if the next page is available use <see cref="IListingResponseModel{T}.HasNextPage"/>.
/// For getting next page use <see cref="IListingResponseModel{T}.GetNextPage"/>.
/// </summary>
/// <returns>The <see cref="IListingResponseModel{TaxonomyGroupModel}"/> instance that represents the listing of taxonomy groups.</returns>
Task<IListingResponseModel<TaxonomyGroupModel>> ListTaxonomyGroupsAsync();
Expand Down

0 comments on commit 35de053

Please sign in to comment.