bolt-python/docs/reference/error/index.html at main · https-saml-salesforce-com/bolt-python

History

166 lines (164 loc) · 11.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

<!doctype html>

<head>

<title>slack_bolt.error API documentation</title>

hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});

hljs.highlightAll();

/* Collapse source docstrings */

setTimeout(() => {

[...document.querySelectorAll('.hljs.language-python > .hljs-string')]

.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))

.forEach(el => {

let d = document.createElement('details');

d.classList.add('hljs-string');

d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);

el.replaceWith(d);

});

}, 100);

})</script>

</head>

<body>

<main>

<h1 class="title">Module <code>slack_bolt.error</code></h1>

</header>

<p>Bolt specific error types.</p>

</section>

</section>

</section>

</section>

<h2 class="section-title" id="header-classes">Classes</h2>

<dl>

<span>class <span class="ident">BoltError</span></span>

<span>(</span><span>*args, **kwargs)</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">class BoltError(Exception):

"""General class in a Bolt app"""</code></pre>

</details>

<div class="desc"><p>General class in a Bolt app</p></div>

<h3>Ancestors</h3>

<li>builtins.Exception</li>

<li>builtins.BaseException</li>

</ul>

<h3>Subclasses</h3>

<li><a title="slack_bolt.error.BoltUnhandledRequestError" href="#slack_bolt.error.BoltUnhandledRequestError">BoltUnhandledRequestError</a></li>

</ul>

</dd>

<span>class <span class="ident">BoltUnhandledRequestError</span></span>

<span>(</span><span>*,<br>request: ForwardRef('BoltRequest') | ForwardRef('AsyncBoltRequest'),<br>current_response: ForwardRef('BoltResponse') | None,<br>last_global_middleware_name: str | None = None)</span>

</code></dt>

<dd>

<span>Expand source code</span>

</summary>

<pre><code class="python">class BoltUnhandledRequestError(BoltError):

request: "BoltRequest" # type: ignore[name-defined]

body: dict

current_response: Optional["BoltResponse"] # type: ignore[name-defined]

last_global_middleware_name: Optional[str]

def __init__(

self,

request: Union["BoltRequest", "AsyncBoltRequest"], # type: ignore[name-defined]

current_response: Optional["BoltResponse"], # type: ignore[name-defined]

last_global_middleware_name: Optional[str] = None,

self.request = request

self.body = request.body if request is not None else {}

self.current_response = current_response

self.last_global_middleware_name = last_global_middleware_name

def __str__(self) -> str:

return "unhandled request error"</code></pre>

</details>

<div class="desc"><p>General class in a Bolt app</p></div>

<h3>Ancestors</h3>

<li><a title="slack_bolt.error.BoltError" href="#slack_bolt.error.BoltError">BoltError</a></li>

<li>builtins.Exception</li>

<li>builtins.BaseException</li>

</ul>

<h3>Class variables</h3>

<dl>

<dd>

<div class="desc"><p>The type of the None singleton.</p></div>

</dd>

<dt id="slack_bolt.error.BoltUnhandledRequestError.current_response"><code class="name">var <span class="ident">current_response</span> : BoltResponse | None</code></dt>

<dd>

<div class="desc"><p>The type of the None singleton.</p></div>

</dd>

<dt id="slack_bolt.error.BoltUnhandledRequestError.last_global_middleware_name"><code class="name">var <span class="ident">last_global_middleware_name</span> : str | None</code></dt>

<dd>

<div class="desc"><p>The type of the None singleton.</p></div>

</dd>

<dt id="slack_bolt.error.BoltUnhandledRequestError.request"><code class="name">var <span class="ident">request</span> : BoltRequest</code></dt>

<dd>

<div class="desc"><p>The type of the None singleton.</p></div>

</dd>

</dl>

</dd>

</dl>

</section>

</article>

</div>

<li><h3>Super-module</h3>

<ul>

<li><code><a title="slack_bolt" href="../index.html">slack_bolt</a></code></li>

</ul>

</li>

<li><h3><a href="#header-classes">Classes</a></h3>

<ul>

<li>

<h4><code><a title="slack_bolt.error.BoltError" href="#slack_bolt.error.BoltError">BoltError</a></code></h4>

</li>

<li>

<h4><code><a title="slack_bolt.error.BoltUnhandledRequestError" href="#slack_bolt.error.BoltUnhandledRequestError">BoltUnhandledRequestError</a></code></h4>

<li><code><a title="slack_bolt.error.BoltUnhandledRequestError.current_response" href="#slack_bolt.error.BoltUnhandledRequestError.current_response">current_response</a></code></li>

<li><code><a title="slack_bolt.error.BoltUnhandledRequestError.last_global_middleware_name" href="#slack_bolt.error.BoltUnhandledRequestError.last_global_middleware_name">last_global_middleware_name</a></code></li>

<li><code><a title="slack_bolt.error.BoltUnhandledRequestError.request" href="#slack_bolt.error.BoltUnhandledRequestError.request">request</a></code></li>

</ul>

</li>

</ul>

</li>

</ul>

</nav>

</main>

<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls