> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# NSURL

> Native instance exported as .

Native instance exported as `NSURL`.

## Properties

**percentEncodedFragment** `string | null` *required*

Exported member.

**percentEncodedHost** `string | null` *required*

Exported member.

**percentEncodedPassword** `string | null` *required*

Exported member.

**percentEncodedPath** `string | null` *required*

Exported member.

**percentEncodedQuery** `string | null` *required*

Exported member.

**percentEncodedUser** `string | null` *required*

Exported member.

**previewItemTitle** `string | null` *required*

Exported member.

**previewItemURL** `NSURL | null` *required*

**Type:** `NSURL | null`

Exported member.

## Methods

### absoluteString()

```typescript
absoluteString(): string | null
```

Exported member.

#### Returns

`string | null`

### absoluteURL()

```typescript
absoluteURL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### allowsWeakReference()

```typescript
allowsWeakReference(): boolean
```

Exported member.

#### Returns

`boolean`

### autorelease()

```typescript
autorelease(): unknown
```

Exported member.

#### Returns

`unknown`

### baseURL()

```typescript
baseURL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### bookmarkDataWithOptionsIncludingResourceValuesForKeysRelativeToURLError()

```typescript
bookmarkDataWithOptionsIncludingResourceValuesForKeysRelativeToURLError(_options: number, _keys: unknown[] | null, _relativeURL: NSURL | null, _error: NSError | null): NSData | null
```

Exported member.

#### Parameters

**\_options** `number` *required*

**\_keys** `unknown[] | null` *required*

**\_relativeURL** `NSURL | null` *required*

**Type:** `NSURL | null`

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`NSData | null`

### checkResourceIsReachableAndReturnError()

```typescript
checkResourceIsReachableAndReturnError(_error: NSError | null): boolean
```

Exported member.

#### Parameters

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`boolean`

### class()

```typescript
class(): NativeClass<NativeObject>
```

Exported member.

#### Returns

`NativeClass<NativeObject>`

### conformsToProtocol()

```typescript
conformsToProtocol(_aProtocol: Protocol | null): boolean
```

Exported member.

#### Parameters

**\_aProtocol** `Protocol | null` *required*

#### Returns

`boolean`

### copy()

```typescript
copy(): unknown
```

Exported member.

#### Returns

`unknown`

### dealloc()

```typescript
dealloc(): void
```

Exported member.

### debugDescription()

```typescript
debugDescription(): string | null
```

Exported member.

#### Returns

`string | null`

### description()

```typescript
description(): string | null
```

Exported member.

#### Returns

`string | null`

### doesNotRecognizeSelector()

```typescript
doesNotRecognizeSelector(_aSelector: string | null): void
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

### filePathURL()

```typescript
filePathURL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### fileReferenceURL()

```typescript
fileReferenceURL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### fileSystemRepresentation()

```typescript
fileSystemRepresentation(): NativePointer | null
```

Exported member.

#### Returns

`NativePointer | null`

### finalize()

```typescript
finalize(): void
```

Exported member.

### forwardingTargetForSelector()

```typescript
forwardingTargetForSelector(_aSelector: string | null): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`unknown`

### forwardInvocation()

```typescript
forwardInvocation(_anInvocation: NSInvocation | null): void
```

Exported member.

#### Parameters

**\_anInvocation** `NSInvocation | null` *required*

### fragment()

```typescript
fragment(): string | null
```

Exported member.

#### Returns

`string | null`

### getFileSystemRepresentationMaxLength()

```typescript
getFileSystemRepresentationMaxLength(_buffer: NativePointer | null, _maxBufferLength: number): boolean
```

Exported member.

#### Parameters

**\_buffer** `NativePointer | null` *required*

**\_maxBufferLength** `number` *required*

#### Returns

`boolean`

### getResourceValueForKeyError()

```typescript
getResourceValueForKeyError(_value: unknown, _key: string | null, _error: NSError | null): boolean
```

Exported member.

#### Parameters

**\_value** `unknown` *required*

**\_key** `string | null` *required*

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`boolean`

### hash()

```typescript
hash(): number
```

Exported member.

#### Returns

`number`

### host()

```typescript
host(): string | null
```

Exported member.

#### Returns

`string | null`

### isEqual()

```typescript
isEqual(_object: unknown): boolean
```

Exported member.

#### Parameters

**\_object** `unknown` *required*

#### Returns

`boolean`

### isFileReferenceURL()

```typescript
isFileReferenceURL(): boolean
```

Exported member.

#### Returns

`boolean`

### isFileURL()

```typescript
isFileURL(): boolean
```

Exported member.

#### Returns

`boolean`

### isKindOfClass()

```typescript
isKindOfClass(_aClass: NativeClass<NativeObject>): boolean
```

Exported member.

#### Parameters

**\_aClass** `NativeClass\<NativeObject\>` *required*

#### Returns

`boolean`

### isMemberOfClass()

```typescript
isMemberOfClass(_aClass: NativeClass<NativeObject>): boolean
```

Exported member.

#### Parameters

**\_aClass** `NativeClass\<NativeObject\>` *required*

#### Returns

`boolean`

### isProxy()

```typescript
isProxy(): boolean
```

Exported member.

#### Returns

`boolean`

### lastPathComponent()

```typescript
lastPathComponent(): string | null
```

Exported member.

#### Returns

`string | null`

### methodForSelector()

```typescript
methodForSelector(_aSelector: NativeSelector): IMP
```

Exported member.

#### Parameters

**\_aSelector** `NativeSelector` *required*

#### Returns

`IMP`

### methodSignatureForSelector()

```typescript
methodSignatureForSelector(_aSelector: string | null): NSMethodSignature | null
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`NSMethodSignature | null`

### mutableCopy()

```typescript
mutableCopy(): unknown
```

Exported member.

#### Returns

`unknown`

### parameterString()

```typescript
parameterString(): string | null
```

Exported member.

#### Returns

`string | null`

### password()

```typescript
password(): string | null
```

Exported member.

#### Returns

`string | null`

### path()

```typescript
path(): string | null
```

Exported member.

#### Returns

`string | null`

### pathComponents()

```typescript
pathComponents(): unknown[] | null
```

Exported member.

#### Returns

`unknown[] | null`

### pathExtension()

```typescript
pathExtension(): string | null
```

Exported member.

#### Returns

`string | null`

### performSelector()

```typescript
performSelector(_aSelector: string | null): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

#### Returns

`unknown`

### performSelectorWithObject()

```typescript
performSelectorWithObject(_aSelector: string | null, _object: unknown): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

**\_object** `unknown` *required*

#### Returns

`unknown`

### performSelectorWithObjectWithObject()

```typescript
performSelectorWithObjectWithObject(_aSelector: string | null, _object1: unknown, _object2: unknown): unknown
```

Exported member.

#### Parameters

**\_aSelector** `string | null` *required*

**\_object1** `unknown` *required*

**\_object2** `unknown` *required*

#### Returns

`unknown`

### port()

```typescript
port(): number | null
```

Exported member.

#### Returns

`number | null`

### query()

```typescript
query(): string | null
```

Exported member.

#### Returns

`string | null`

### relativePath()

```typescript
relativePath(): string | null
```

Exported member.

#### Returns

`string | null`

### relativeString()

```typescript
relativeString(): string | null
```

Exported member.

#### Returns

`string | null`

### release()

```typescript
release(): void
```

Exported member.

### removeAllCachedResourceValues()

```typescript
removeAllCachedResourceValues(): void
```

Exported member.

### removeCachedResourceValueForKey()

```typescript
removeCachedResourceValueForKey(_key: string | null): void
```

Exported member.

#### Parameters

**\_key** `string | null` *required*

### resourceSpecifier()

```typescript
resourceSpecifier(): string | null
```

Exported member.

#### Returns

`string | null`

### resourceValuesForKeysError()

```typescript
resourceValuesForKeysError(_keys: unknown[] | null, _error: NSError | null): Record<string, unknown> | null
```

Exported member.

#### Parameters

**\_keys** `unknown[] | null` *required*

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`Record<string, unknown> | null`

### respondsToSelector()

```typescript
respondsToSelector(_aSelector: NativeSelector): boolean
```

Exported member.

#### Parameters

**\_aSelector** `NativeSelector` *required*

#### Returns

`boolean`

### retain()

```typescript
retain(): unknown
```

Exported member.

#### Returns

`unknown`

### retainCount()

```typescript
retainCount(): number
```

Exported member.

#### Returns

`number`

### retainWeakReference()

```typescript
retainWeakReference(): boolean
```

Exported member.

#### Returns

`boolean`

### scheme()

```typescript
scheme(): string | null
```

Exported member.

#### Returns

`string | null`

### self()

```typescript
self(): unknown
```

Exported member.

#### Returns

`unknown`

### setResourceValueForKeyError()

```typescript
setResourceValueForKeyError(_value: unknown, _key: string | null, _error: NSError | null): boolean
```

Exported member.

#### Parameters

**\_value** `unknown` *required*

**\_key** `string | null` *required*

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`boolean`

### setResourceValuesError()

```typescript
setResourceValuesError(_keyedValues: Record<string, unknown> | null, _error: NSError | null): boolean
```

Exported member.

#### Parameters

**\_keyedValues** `Record\<string, unknown\> | null` *required*

**\_error** `NSError | null` *required*

**Type:** `NSError | null`

#### Returns

`boolean`

### setTemporaryResourceValueForKey()

```typescript
setTemporaryResourceValueForKey(_value: unknown, _key: string | null): void
```

Exported member.

#### Parameters

**\_value** `unknown` *required*

**\_key** `string | null` *required*

### standardizedURL()

```typescript
standardizedURL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### startAccessingSecurityScopedResource()

```typescript
startAccessingSecurityScopedResource(): boolean
```

Exported member.

#### Returns

`boolean`

### stopAccessingSecurityScopedResource()

```typescript
stopAccessingSecurityScopedResource(): void
```

Exported member.

### stringByAddingPercentEncodingWithAllowedCharacters()

```typescript
stringByAddingPercentEncodingWithAllowedCharacters(_allowedCharacters: NSCharacterSet | null): string | null
```

Exported member.

#### Parameters

**\_allowedCharacters** `NSCharacterSet | null` *required*

**Type:** `NSCharacterSet | null`

#### Returns

`string | null`

### stringByAddingPercentEscapesUsingEncoding()

```typescript
stringByAddingPercentEscapesUsingEncoding(_enc: number): string | null
```

Exported member.

#### Parameters

**\_enc** `number` *required*

#### Returns

`string | null`

### stringByRemovingPercentEncoding()

```typescript
stringByRemovingPercentEncoding(): string | null
```

Exported member.

#### Returns

`string | null`

### stringByReplacingPercentEscapesUsingEncoding()

```typescript
stringByReplacingPercentEscapesUsingEncoding(_enc: number): string | null
```

Exported member.

#### Parameters

**\_enc** `number` *required*

#### Returns

`string | null`

### superclass()

```typescript
superclass(): NativeClass<NativeObject>
```

Exported member.

#### Returns

`NativeClass<NativeObject>`

### URL()

```typescript
URL(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### URLByAppendingPathComponent()

```typescript
URLByAppendingPathComponent(_pathComponent: string | null): NSURL | null
```

Exported member.

#### Parameters

**\_pathComponent** `string | null` *required*

#### Returns

`NSURL | null`

### URLByAppendingPathComponentIsDirectory()

```typescript
URLByAppendingPathComponentIsDirectory(_pathComponent: string | null, _isDirectory: boolean): NSURL | null
```

Exported member.

#### Parameters

**\_pathComponent** `string | null` *required*

**\_isDirectory** `boolean` *required*

#### Returns

`NSURL | null`

### URLByAppendingPathExtension()

```typescript
URLByAppendingPathExtension(_pathExtension: string | null): NSURL | null
```

Exported member.

#### Parameters

**\_pathExtension** `string | null` *required*

#### Returns

`NSURL | null`

### URLByDeletingLastPathComponent()

```typescript
URLByDeletingLastPathComponent(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### URLByDeletingPathExtension()

```typescript
URLByDeletingPathExtension(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### URLByResolvingSymlinksInPath()

```typescript
URLByResolvingSymlinksInPath(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### URLByStandardizingPath()

```typescript
URLByStandardizingPath(): NSURL | null
```

Exported member.

#### Returns

`NSURL | null`

### URLRelativeToURL()

```typescript
URLRelativeToURL(_baseURL: NSURL | null): NSURL | null
```

Exported member.

#### Parameters

**\_baseURL** `NSURL | null` *required*

**Type:** `NSURL | null`

#### Returns

`NSURL | null`

### user()

```typescript
user(): string | null
```

Exported member.

#### Returns

`string | null`

### zone()

```typescript
zone(): NativePointer | null
```

Exported member.

#### Returns

`NativePointer | null`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.