private void Validate(TraktSearchResultType searchResultType)
{
if (searchResultType == null)
{
throw new ArgumentNullException(nameof(searchResultType), "search result type must not be null");
}
if (searchResultType == TraktSearchResultType.Unspecified)
{
throw new ArgumentException("search result type not valid", nameof(searchResultType));
}
}
public async Task <TraktPaginationListResult <TraktSearchResult> > GetTextQueryResultsAsync(TraktSearchResultType searchResultTypes, [NotNull] string searchQuery,
TraktSearchField searchFields = null, TraktSearchFilter filter = null,
TraktExtendedInfo extendedInfo = null,
int?page = null, int?limitPerPage = null)
{
Validate(searchResultTypes);
Validate(searchQuery);
return(await QueryAsync(new TraktSearchTextQueryRequest(Client)
{
ResultTypes = searchResultTypes,
Query = searchQuery,
SearchFields = searchFields,
Filter = filter,
ExtendedInfo = extendedInfo,
PaginationOptions = new TraktPaginationOptions(page, limitPerPage)
}));
}
public async Task <TraktPaginationListResult <TraktSearchResult> > GetIdLookupResultsAsync(TraktSearchIdType searchIdType, [NotNull] string lookupId,
TraktSearchResultType searchResultType = null,
TraktExtendedInfo extendedInfo = null,
int?page = null, int?limitPerPage = null)
{
Validate(searchIdType, lookupId);
return(await QueryAsync(new TraktSearchIdLookupRequest(Client)
{
IdType = searchIdType,
LookupId = lookupId,
ResultType = searchResultType,
ExtendedInfo = extendedInfo,
PaginationOptions = new TraktPaginationOptions(page, limitPerPage)
}));
}
public void TestTraktSearchResultTypeIsTraktEnumeration()
{
var enumeration = new TraktSearchResultType();
enumeration.Should().BeAssignableTo <TraktEnumeration>();
}
public async Task <TraktPaginationListResult <TraktSearchResult> > GetTextQueryResultsAsync([NotNull] string searchQuery, TraktSearchResultType searchResultType = null,
int?year = null, int?page = null, int?limitPerPage = null)
{
Validate(searchQuery);
return(await QueryAsync(new TraktSearchOldTextQueryRequest(Client)
{
Query = searchQuery,
Type = searchResultType,
Year = year,
PaginationOptions = new TraktPaginationOptions(page, limitPerPage)
}));
}
/// <summary>
/// Searches for movies, shows, episodes, people and / or lists with the given search query.
/// <para>OAuth authorization not required.</para>
/// <para>
/// See <a href="http://docs.trakt.apiary.io/#reference/search/text-query/get-text-query-results">"Trakt API Doc - Search: Text Query"</a> for more information.
/// </para>
/// </summary>
/// <param name="searchResultTypes">
/// The object type(s), for which will be searched. See also <seealso cref="TraktSearchResultType" />.
/// Multiple <see cref="TraktSearchResultType" /> values can be combined with a binary operator, like this: TraktSearchResultType.Movie | TraktSearchResultType.Show.
/// </param>
/// <param name="searchQuery">The query, for which will be searched.</param>
/// <param name="searchFields">Determines the text fields, which will be searched. See also <seealso cref="TraktSearchField" />.</param>
/// <param name="filter">Optional filter for genres, year, runtimes, ratings, etc. See also <seealso cref="TraktSearchFilter" />.</param>
/// <param name="extendedInfo">
/// The extended info, which determines how much data about the movies, shows, episodes, people and / or lists should be queried.
/// See also <seealso cref="TraktExtendedInfo" />.
/// </param>
/// <param name="pagedParameters"></param>
/// <param name="cancellationToken"></param>
/// <returns>
/// An <see cref="TraktPagedResponse{ITraktSearchResult}"/> instance containing the found movies, shows, episodes, people and / or lists and which also
/// contains the queried page number, the page's item count, maximum page count and maximum item count.
/// <para>
/// See also <seealso cref="TraktPagedResponse{ListItem}" /> and <seealso cref="ITraktSearchResult" />.
/// </para>
/// </returns>
/// <exception cref="TraktException">Thrown, if the request fails.</exception>
/// <exception cref="ArgumentException">
/// Thrown, if the given searchQuery is null, empty or contains spaces.
/// Thrown, if the given searchResultType is unspecified.
/// </exception>
/// <exception cref="ArgumentNullException">Thrown, if the given searchResultType is null</exception>
public Task <TraktPagedResponse <ITraktSearchResult> > GetTextQueryResultsAsync(TraktSearchResultType searchResultTypes, string searchQuery,
TraktSearchField searchFields = null, TraktSearchFilter filter = null,
TraktExtendedInfo extendedInfo = null,
TraktPagedParameters pagedParameters = null,
CancellationToken cancellationToken = default)
{
var requestHandler = new RequestHandler(Client);
return(requestHandler.ExecutePagedRequestAsync(new SearchTextQueryRequest
{
ResultTypes = searchResultTypes,
Query = searchQuery,
SearchFields = searchFields,
Filter = filter,
ExtendedInfo = extendedInfo,
Page = pagedParameters?.Page,
Limit = pagedParameters?.Limit
},
cancellationToken));
}
/// <summary>
/// Looks up items by their Trakt-, IMDB-, TMDB-, TVDB- or TVRage-Id.
/// <para>OAuth authorization not required.</para>
/// <para>
/// See <a href="http://docs.trakt.apiary.io/#reference/search/text-query/get-id-lookup-results">"Trakt API Doc - Search: Id Lookup"</a> for more information.
/// </para>
/// </summary>
/// <param name="searchIdType">The id type, which should be looked up. See also <seealso cref="TraktSearchIdType" />.</param>
/// <param name="lookupId">The Trakt-, IMDB-, TMDB-, TVDB- or TVRage-Id, which will be looked up.</param>
/// <param name="searchResultTypes">The object type(s), which will be looked up. See also <seealso cref="TraktSearchResultType" />.</param>
/// <param name="extendedInfo">
/// The extended info, which determines how much data about the lookup object(s) should be queried.
/// See also <seealso cref="TraktExtendedInfo" />.
/// </param>
/// <param name="pagedParameters"></param>
/// <param name="cancellationToken"></param>
/// <returns>
/// An <see cref="TraktPagedResponse{ITraktSearchResult}"/> instance containing the found movies, shows, episodes, people and / or lists and which also
/// contains the queried page number, the page's item count, maximum page count and maximum item count.
/// <para>
/// See also <seealso cref="TraktPagedResponse{ListItem}" /> and <seealso cref="ITraktSearchResult" />.
/// </para>
/// </returns>
/// <exception cref="TraktException">Thrown, if the request fails.</exception>
/// <exception cref="ArgumentException">
/// Thrown, if the given lookupId is null, empty or contains spaces.
/// Thrown, if the given searchIdType is unspecified.
/// </exception>
/// <exception cref="ArgumentNullException">Thrown, if the given searchIdType is null.</exception>
public Task <TraktPagedResponse <ITraktSearchResult> > GetIdLookupResultsAsync(TraktSearchIdType searchIdType, string lookupId,
TraktSearchResultType searchResultTypes = null,
TraktExtendedInfo extendedInfo = null,
TraktPagedParameters pagedParameters = null,
CancellationToken cancellationToken = default)
{
var requestHandler = new RequestHandler(Client);
return(requestHandler.ExecutePagedRequestAsync(new SearchIdLookupRequest
{
IdType = searchIdType,
LookupId = lookupId,
ResultTypes = searchResultTypes,
ExtendedInfo = extendedInfo,
Page = pagedParameters?.Page,
Limit = pagedParameters?.Limit
},
cancellationToken));
}
