websIDE
  • webside
    • Overview
  • API
    • General
      • Dialect
      • Version
      • Colors
      • Logo
      • Stats
      • Themes
      • Icons
      • Save Image
    • Changes
      • Retrieve changes
      • Apply a change
    • Changesets
      • Convert chunks to JSON changes
      • Convert JSON changes to chunks
    • Code
      • Autocompletions
        • Retrieve autocompletions
      • Categories
        • Retrieve categories
        • Retrieve usual categories
      • Classes
        • Retrieve classes
        • Retrieve a class
        • Retrieve categories
        • Retrieve variables
        • Retrieve class variables
        • Retrieve instance variables
        • Retrieve selectors
        • Retrieve methods
        • Retrieve method
        • Retrieve method history
        • Retrieve subclasses
        • Retrieve superclasses
        • Retrieve used categories
      • Methods
        • Retrieve methods
      • Packages
        • Retrieve packages
        • Retrieve a package
        • Retrieve package classes
        • Retrieve package methods
      • Search
      • Selectors
        • Find selector in source code
      • Templates
        • Retrieve class template
        • Retrieve method template
    • Debuggers
      • Retrieve active debuggers
      • Create a debugger
      • Delete debugger
      • Retrieve debugger frames
      • Retrieve debugger frame
      • Retrieve frame bindings
      • Restart debugger
      • Resume debugger
      • Step into debugger
      • Step over debugger
      • Step through debugger
      • Terminate debugger
    • Evaluations
      • Retrieve evaluations
      • Evaluate an expression
      • Cancel evaluation
      • Retrieve evaluation
      • Pause evaluation
      • Resume evaluation
    • Extensions
      • Retrieve extensions
      • Changes extensions
      • Export extensions
      • Search extensions
    • Commands
      • Retrieve command definitions
      • Invoke commands
    • Objects
      • Retrieve pinned objects
      • Pin object
      • Retrieve pinned object
      • Retrieve pinned object slots
        • Custom views
      • Unpin an object
      • Unpin all objects
    • Processes
      • Retrieve active processes
    • Profilers
      • Retrieve active profilers
      • Create a new profiler
      • Delete a profiler
      • Retrieve a profiler
      • Retrieve profiler ranking results
      • Retrieve profiler tree results
    • Testing
      • Run tests
      • Retrieve test run status
      • Retrieve test run results
    • Workspaces
      • Retrieve active workspaces
      • Create a new workspace
      • Delete a workspace
      • Retrieve a workspace
      • Update a workspace
      • Retrieve workspace bindings
Powered by GitBook
On this page
  1. API
  2. Code

Search

This endpoint serves for searching the system for code elements (selectors, methods, classes, packages, etc.).

URL: /search

Method: GET

Query Options

Option
Type
Description

text

string

The text to compare with

ignoreCase

boolean

Whether to ignore the case when comparing. false by default

condition

string

Either beginning (default), including, ending or similar

type

string

Either all (default), selector, class, package, or pool

Success Responses

Code : 200 OK

Content: [result] where result is defined as:

{
	"type": "string",
	"text": "string"
}

Where type is the type of the element found and can be either project, class, selector, method or pool.

Example 1:: every element starting with "asInt" without taking care of the case, GET /search?text=asInt&ignoreCase=true.

[
	{
		"type": "selector",
		"text": "asInteger"
	},
	{
		"type": "selector",
		"text": "asInterval"
	},
	{
		"type": "selector",
		"text": "asInternationalTimestamp"
	}
]

Example 2:: every class whose name ends with "ix", GET /search?text=x&condition=ending&type=classes.

[
	{
		"type": "class",
		"text": "FlatMatrix"
	},
	{
		"type": "class",
		"text": "ByteMatrix"
	},
	{
		"type": "class",
		"text": "ColorMatrix"
	},
	{
		"type": "class",
		"text": "FloatMatrix"
	},
	{
		"type": "class",
		"text": "OpenCLMatrix"
	},
	{
		"type": "class",
		"text": "CorrelationMatrix"
	},
	{
		"type": "class",
		"text": "InstructionPrefix"
	},
	{
		"type": "class",
		"text": "IncompleteGammaPrefix"
	}
]

Example 3:: classes whose name is similar to "Sream", GET /search?text=Sream&condition=similar&type=classes.

[
	{
		"type": "class",
		"text": "FlatMatrix"
	},
	{
		"type": "class",
		"text": "ByteMatrix"
	},
	{
		"type": "class",
		"text": "ColorMatrix"
	},
	{
		"type": "class",
		"text": "FloatMatrix"
	},
	{
		"type": "class",
		"text": "OpenCLMatrix"
	},
	{
		"type": "class",
		"text": "CorrelationMatrix"
	},
	{
		"type": "class",
		"text": "InstructionPrefix"
	},
	{
		"type": "class",
		"text": "IncompleteGammaPrefix"
	}
]
PreviousRetrieve package methodsNextSelectors

Last updated 1 year ago