search

package
v0.0.0-...-6bd88e3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2024 License: AGPL-3.0-or-later Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for search API

func (*Client) SearchGet 

func (a *Client) SearchGet(params *SearchGetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchGetOK, error)

SearchGet searches for statuses accounts or hashtags on this instance or elsewhere

If statuses are in the result, they will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	SearchGet(params *SearchGetParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchGetOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new search API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new search API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new search API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type SearchGetBadRequest 

type SearchGetBadRequest struct {
}

SearchGetBadRequest describes a response with status code 400, with default header values.

bad request

func NewSearchGetBadRequest 

func NewSearchGetBadRequest() *SearchGetBadRequest

NewSearchGetBadRequest creates a SearchGetBadRequest with default headers values

func (*SearchGetBadRequest) Code 

func (o *SearchGetBadRequest) Code() int

Code gets the status code for the search get bad request response

func (*SearchGetBadRequest) Error 

func (o *SearchGetBadRequest) Error() string

func (*SearchGetBadRequest) IsClientError 

func (o *SearchGetBadRequest) IsClientError() bool

IsClientError returns true when this search get bad request response has a 4xx status code

func (*SearchGetBadRequest) IsCode 

func (o *SearchGetBadRequest) IsCode(code int) bool

IsCode returns true when this search get bad request response a status code equal to that given

func (*SearchGetBadRequest) IsRedirect 

func (o *SearchGetBadRequest) IsRedirect() bool

IsRedirect returns true when this search get bad request response has a 3xx status code

func (*SearchGetBadRequest) IsServerError 

func (o *SearchGetBadRequest) IsServerError() bool

IsServerError returns true when this search get bad request response has a 5xx status code

func (*SearchGetBadRequest) IsSuccess 

func (o *SearchGetBadRequest) IsSuccess() bool

IsSuccess returns true when this search get bad request response has a 2xx status code

func (*SearchGetBadRequest) String 

func (o *SearchGetBadRequest) String() string

type SearchGetInternalServerError 

type SearchGetInternalServerError struct {
}

SearchGetInternalServerError describes a response with status code 500, with default header values.

internal server error

func NewSearchGetInternalServerError 

func NewSearchGetInternalServerError() *SearchGetInternalServerError

NewSearchGetInternalServerError creates a SearchGetInternalServerError with default headers values

func (*SearchGetInternalServerError) Code 

func (o *SearchGetInternalServerError) Code() int

Code gets the status code for the search get internal server error response

func (*SearchGetInternalServerError) Error 

func (o *SearchGetInternalServerError) Error() string

func (*SearchGetInternalServerError) IsClientError 

func (o *SearchGetInternalServerError) IsClientError() bool

IsClientError returns true when this search get internal server error response has a 4xx status code

func (*SearchGetInternalServerError) IsCode 

func (o *SearchGetInternalServerError) IsCode(code int) bool

IsCode returns true when this search get internal server error response a status code equal to that given

func (*SearchGetInternalServerError) IsRedirect 

func (o *SearchGetInternalServerError) IsRedirect() bool

IsRedirect returns true when this search get internal server error response has a 3xx status code

func (*SearchGetInternalServerError) IsServerError 

func (o *SearchGetInternalServerError) IsServerError() bool

IsServerError returns true when this search get internal server error response has a 5xx status code

func (*SearchGetInternalServerError) IsSuccess 

func (o *SearchGetInternalServerError) IsSuccess() bool

IsSuccess returns true when this search get internal server error response has a 2xx status code

func (*SearchGetInternalServerError) String 

func (o *SearchGetInternalServerError) String() string

type SearchGetNotAcceptable 

type SearchGetNotAcceptable struct {
}

SearchGetNotAcceptable describes a response with status code 406, with default header values.

not acceptable

func NewSearchGetNotAcceptable 

func NewSearchGetNotAcceptable() *SearchGetNotAcceptable

NewSearchGetNotAcceptable creates a SearchGetNotAcceptable with default headers values

func (*SearchGetNotAcceptable) Code 

func (o *SearchGetNotAcceptable) Code() int

Code gets the status code for the search get not acceptable response

func (*SearchGetNotAcceptable) Error 

func (o *SearchGetNotAcceptable) Error() string

func (*SearchGetNotAcceptable) IsClientError 

func (o *SearchGetNotAcceptable) IsClientError() bool

IsClientError returns true when this search get not acceptable response has a 4xx status code

func (*SearchGetNotAcceptable) IsCode 

func (o *SearchGetNotAcceptable) IsCode(code int) bool

IsCode returns true when this search get not acceptable response a status code equal to that given

func (*SearchGetNotAcceptable) IsRedirect 

func (o *SearchGetNotAcceptable) IsRedirect() bool

IsRedirect returns true when this search get not acceptable response has a 3xx status code

func (*SearchGetNotAcceptable) IsServerError 

func (o *SearchGetNotAcceptable) IsServerError() bool

IsServerError returns true when this search get not acceptable response has a 5xx status code

func (*SearchGetNotAcceptable) IsSuccess 

func (o *SearchGetNotAcceptable) IsSuccess() bool

IsSuccess returns true when this search get not acceptable response has a 2xx status code

func (*SearchGetNotAcceptable) String 

func (o *SearchGetNotAcceptable) String() string

type SearchGetNotFound 

type SearchGetNotFound struct {
}

SearchGetNotFound describes a response with status code 404, with default header values.

not found

func NewSearchGetNotFound 

func NewSearchGetNotFound() *SearchGetNotFound

NewSearchGetNotFound creates a SearchGetNotFound with default headers values

func (*SearchGetNotFound) Code 

func (o *SearchGetNotFound) Code() int

Code gets the status code for the search get not found response

func (*SearchGetNotFound) Error 

func (o *SearchGetNotFound) Error() string

func (*SearchGetNotFound) IsClientError 

func (o *SearchGetNotFound) IsClientError() bool

IsClientError returns true when this search get not found response has a 4xx status code

func (*SearchGetNotFound) IsCode 

func (o *SearchGetNotFound) IsCode(code int) bool

IsCode returns true when this search get not found response a status code equal to that given

func (*SearchGetNotFound) IsRedirect 

func (o *SearchGetNotFound) IsRedirect() bool

IsRedirect returns true when this search get not found response has a 3xx status code

func (*SearchGetNotFound) IsServerError 

func (o *SearchGetNotFound) IsServerError() bool

IsServerError returns true when this search get not found response has a 5xx status code

func (*SearchGetNotFound) IsSuccess 

func (o *SearchGetNotFound) IsSuccess() bool

IsSuccess returns true when this search get not found response has a 2xx status code

func (*SearchGetNotFound) String 

func (o *SearchGetNotFound) String() string

type SearchGetOK 

type SearchGetOK struct {
	Payload *models.SearchResult
}

SearchGetOK describes a response with status code 200, with default header values.

Results of the search.

func NewSearchGetOK 

func NewSearchGetOK() *SearchGetOK

NewSearchGetOK creates a SearchGetOK with default headers values

func (*SearchGetOK) Code 

func (o *SearchGetOK) Code() int

Code gets the status code for the search get o k response

func (*SearchGetOK) Error 

func (o *SearchGetOK) Error() string

func (*SearchGetOK) GetPayload 

func (o *SearchGetOK) GetPayload() *models.SearchResult

func (*SearchGetOK) IsClientError 

func (o *SearchGetOK) IsClientError() bool

IsClientError returns true when this search get o k response has a 4xx status code

func (*SearchGetOK) IsCode 

func (o *SearchGetOK) IsCode(code int) bool

IsCode returns true when this search get o k response a status code equal to that given

func (*SearchGetOK) IsRedirect 

func (o *SearchGetOK) IsRedirect() bool

IsRedirect returns true when this search get o k response has a 3xx status code

func (*SearchGetOK) IsServerError 

func (o *SearchGetOK) IsServerError() bool

IsServerError returns true when this search get o k response has a 5xx status code

func (*SearchGetOK) IsSuccess 

func (o *SearchGetOK) IsSuccess() bool

IsSuccess returns true when this search get o k response has a 2xx status code

func (*SearchGetOK) String 

func (o *SearchGetOK) String() string

type SearchGetParams 

type SearchGetParams struct {

	/* AccountID.

	   Restrict results to statuses created by the specified account.
	*/
	AccountID *string

	/* APIVersion.

	   Version of the API to use. Must be either `v1` or `v2`. If v1 is used, Hashtag results will be a slice of strings. If v2 is used, Hashtag results will be a slice of apimodel tags.
	*/
	APIVersion string

	/* ExcludeUnreviewed.

	   If searching for hashtags, exclude those not yet approved by instance admin. Currently this parameter is unused.
	*/
	ExcludeUnreviewed *bool

	/* Following.

	   If search type includes accounts, and search query is an arbitrary string, show only accounts that the requesting account follows. If this is set to `true`, then the GoToSocial instance will enhance the search by also searching within account notes, not just in usernames and display names.
	*/
	Following *bool

	/* Limit.

	   Number of each type of item to return.

	   Default: 20
	*/
	Limit *int64

	/* MaxID.

	   Return only items *OLDER* than the given max ID. The item with the specified ID will not be included in the response. Currently only used if 'type' is set to a specific type.
	*/
	MaxID *string

	/* MinID.

	   Return only items *immediately newer* than the given min ID. The item with the specified ID will not be included in the response. Currently only used if 'type' is set to a specific type.
	*/
	MinID *string

	/* Offset.

	   Page number of results to return (starts at 0). This parameter is currently not used, page by selecting a specific query type and using maxID and minID instead.
	*/
	Offset *int64

	/* Q.

	     Query string to search for. This can be in the following forms:
	- `@[username]` -- search for an account with the given username on any domain. Can return multiple results.
	- @[username]@[domain]` -- search for a remote account with exact username and domain. Will only ever return 1 result at most.
	- `https://example.org/some/arbitrary/url` -- search for an account OR a status with the given URL. Will only ever return 1 result at most.
	- `#[hashtag_name]` -- search for a hashtag with the given hashtag name, or starting with the given hashtag name. Case insensitive. Can return multiple results.
	- any arbitrary string -- search for accounts or statuses containing the given string. Can return multiple results.

	Arbitrary string queries may include the following operators:
	- `from:localuser`, `from:remoteuser@instance.tld`: restrict results to statuses created by the specified account.
	*/
	Q string

	/* Resolve.

	   If searching query is for `@[username]@[domain]`, or a URL, allow the GoToSocial instance to resolve the search by making calls to remote instances (webfinger, ActivityPub, etc).
	*/
	Resolve *bool

	/* Type.

	     Type of item to return. One of:
	- “ -- empty string; return any/all results.
	- `accounts` -- return only account(s).
	- `statuses` -- return only status(es).
	- `hashtags` -- return only hashtag(s).
	If `type` is specified, paging can be performed using max_id and min_id parameters.
	If `type` is not specified, see the `offset` parameter for paging.
	*/
	Type *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

SearchGetParams contains all the parameters to send to the API endpoint 

for the search get operation.

Typically these are written to a http.Request.

func NewSearchGetParams 

func NewSearchGetParams() *SearchGetParams

NewSearchGetParams creates a new SearchGetParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewSearchGetParamsWithContext 

func NewSearchGetParamsWithContext(ctx context.Context) *SearchGetParams

NewSearchGetParamsWithContext creates a new SearchGetParams object with the ability to set a context for a request.

func NewSearchGetParamsWithHTTPClient 

func NewSearchGetParamsWithHTTPClient(client *http.Client) *SearchGetParams

NewSearchGetParamsWithHTTPClient creates a new SearchGetParams object with the ability to set a custom HTTPClient for a request.

func NewSearchGetParamsWithTimeout 

func NewSearchGetParamsWithTimeout(timeout time.Duration) *SearchGetParams

NewSearchGetParamsWithTimeout creates a new SearchGetParams object with the ability to set a timeout on a request.

func (*SearchGetParams) SetAPIVersion 

func (o *SearchGetParams) SetAPIVersion(aPIVersion string)

SetAPIVersion adds the apiVersion to the search get params

func (*SearchGetParams) SetAccountID 

func (o *SearchGetParams) SetAccountID(accountID *string)

SetAccountID adds the accountId to the search get params

func (*SearchGetParams) SetContext 

func (o *SearchGetParams) SetContext(ctx context.Context)

SetContext adds the context to the search get params

func (*SearchGetParams) SetDefaults 

func (o *SearchGetParams) SetDefaults()

SetDefaults hydrates default values in the search get params (not the query body).

All values with no default are reset to their zero value.

func (*SearchGetParams) SetExcludeUnreviewed 

func (o *SearchGetParams) SetExcludeUnreviewed(excludeUnreviewed *bool)

SetExcludeUnreviewed adds the excludeUnreviewed to the search get params

func (*SearchGetParams) SetFollowing 

func (o *SearchGetParams) SetFollowing(following *bool)

SetFollowing adds the following to the search get params

func (*SearchGetParams) SetHTTPClient 

func (o *SearchGetParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the search get params

func (*SearchGetParams) SetLimit 

func (o *SearchGetParams) SetLimit(limit *int64)

SetLimit adds the limit to the search get params

func (*SearchGetParams) SetMaxID 

func (o *SearchGetParams) SetMaxID(maxID *string)

SetMaxID adds the maxId to the search get params

func (*SearchGetParams) SetMinID 

func (o *SearchGetParams) SetMinID(minID *string)

SetMinID adds the minId to the search get params

func (*SearchGetParams) SetOffset 

func (o *SearchGetParams) SetOffset(offset *int64)

SetOffset adds the offset to the search get params

func (*SearchGetParams) SetQ 

func (o *SearchGetParams) SetQ(q string)

SetQ adds the q to the search get params

func (*SearchGetParams) SetResolve 

func (o *SearchGetParams) SetResolve(resolve *bool)

SetResolve adds the resolve to the search get params

func (*SearchGetParams) SetTimeout 

func (o *SearchGetParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the search get params

func (*SearchGetParams) SetType 

func (o *SearchGetParams) SetType(typeVar *string)

SetType adds the type to the search get params

func (*SearchGetParams) WithAPIVersion 

func (o *SearchGetParams) WithAPIVersion(aPIVersion string) *SearchGetParams

WithAPIVersion adds the aPIVersion to the search get params

func (*SearchGetParams) WithAccountID 

func (o *SearchGetParams) WithAccountID(accountID *string) *SearchGetParams

WithAccountID adds the accountID to the search get params

func (*SearchGetParams) WithContext 

func (o *SearchGetParams) WithContext(ctx context.Context) *SearchGetParams

WithContext adds the context to the search get params

func (*SearchGetParams) WithDefaults 

func (o *SearchGetParams) WithDefaults() *SearchGetParams

WithDefaults hydrates default values in the search get params (not the query body).

All values with no default are reset to their zero value.

func (*SearchGetParams) WithExcludeUnreviewed 

func (o *SearchGetParams) WithExcludeUnreviewed(excludeUnreviewed *bool) *SearchGetParams

WithExcludeUnreviewed adds the excludeUnreviewed to the search get params

func (*SearchGetParams) WithFollowing 

func (o *SearchGetParams) WithFollowing(following *bool) *SearchGetParams

WithFollowing adds the following to the search get params

func (*SearchGetParams) WithHTTPClient 

func (o *SearchGetParams) WithHTTPClient(client *http.Client) *SearchGetParams

WithHTTPClient adds the HTTPClient to the search get params

func (*SearchGetParams) WithLimit 

func (o *SearchGetParams) WithLimit(limit *int64) *SearchGetParams

WithLimit adds the limit to the search get params

func (*SearchGetParams) WithMaxID 

func (o *SearchGetParams) WithMaxID(maxID *string) *SearchGetParams

WithMaxID adds the maxID to the search get params

func (*SearchGetParams) WithMinID 

func (o *SearchGetParams) WithMinID(minID *string) *SearchGetParams

WithMinID adds the minID to the search get params

func (*SearchGetParams) WithOffset 

func (o *SearchGetParams) WithOffset(offset *int64) *SearchGetParams

WithOffset adds the offset to the search get params

func (*SearchGetParams) WithQ 

func (o *SearchGetParams) WithQ(q string) *SearchGetParams

WithQ adds the q to the search get params

func (*SearchGetParams) WithResolve 

func (o *SearchGetParams) WithResolve(resolve *bool) *SearchGetParams

WithResolve adds the resolve to the search get params

func (*SearchGetParams) WithTimeout 

func (o *SearchGetParams) WithTimeout(timeout time.Duration) *SearchGetParams

WithTimeout adds the timeout to the search get params

func (*SearchGetParams) WithType 

func (o *SearchGetParams) WithType(typeVar *string) *SearchGetParams

WithType adds the typeVar to the search get params

func (*SearchGetParams) WriteToRequest 

func (o *SearchGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type SearchGetReader 

type SearchGetReader struct {
	// contains filtered or unexported fields
}

SearchGetReader is a Reader for the SearchGet structure.

func (*SearchGetReader) ReadResponse 

func (o *SearchGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type SearchGetUnauthorized 

type SearchGetUnauthorized struct {
}

SearchGetUnauthorized describes a response with status code 401, with default header values.

unauthorized

func NewSearchGetUnauthorized 

func NewSearchGetUnauthorized() *SearchGetUnauthorized

NewSearchGetUnauthorized creates a SearchGetUnauthorized with default headers values

func (*SearchGetUnauthorized) Code 

func (o *SearchGetUnauthorized) Code() int

Code gets the status code for the search get unauthorized response

func (*SearchGetUnauthorized) Error 

func (o *SearchGetUnauthorized) Error() string

func (*SearchGetUnauthorized) IsClientError 

func (o *SearchGetUnauthorized) IsClientError() bool

IsClientError returns true when this search get unauthorized response has a 4xx status code

func (*SearchGetUnauthorized) IsCode 

func (o *SearchGetUnauthorized) IsCode(code int) bool

IsCode returns true when this search get unauthorized response a status code equal to that given

func (*SearchGetUnauthorized) IsRedirect 

func (o *SearchGetUnauthorized) IsRedirect() bool

IsRedirect returns true when this search get unauthorized response has a 3xx status code

func (*SearchGetUnauthorized) IsServerError 

func (o *SearchGetUnauthorized) IsServerError() bool

IsServerError returns true when this search get unauthorized response has a 5xx status code

func (*SearchGetUnauthorized) IsSuccess 

func (o *SearchGetUnauthorized) IsSuccess() bool

IsSuccess returns true when this search get unauthorized response has a 2xx status code

func (*SearchGetUnauthorized) String 

func (o *SearchGetUnauthorized) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.